Skip to content

lampeggiante/react-note

Repository files navigation

写在前面

本项目是一个纯前端项目,用于练手 react ,写这个项目参考了几篇掘金的文章,如下:

项目技术栈

  • React 18: 这个没什么好说的了,里面用了几个钩子函数,useStateuseEffectuseCallbackuseRef

  • react-router-dom,主要使用 react-router-dom 作为导航实现跳转

  • zustand 听说这个相较于 redux 会更加的轻量,所以就使用了 zustand 结合 immer 构成了状态管理工具

  • vite 5.0 写这个项目的时候刚好看到了使用 vite 搭建的教程,就使用 vite 尝试一下,最终也是发现 vite 的搭建速度相较于 webpack 快了不止一星半点,而且对于电脑性能要求也比较低,我的轻薄本CPU的型号是 i5-1135G7, 在项目编译打包的过程中也没有任何发热情况。

  • sass 因为之前写的项目使用的是 sass,对这个比较熟悉,于是就用这个来编写样式

  • 最后就是说一下本项目之所以为纯前端项目,是因为数据仅保留在 localStorage 中,并没有为这个项目专门搭建后端,所有数据都会保留在浏览器端。

项目功能

基础功能

使用 MarkDown 记录笔记,管理笔记,实现了收藏和回收的功能,可以在笔记和收藏页面对笔记进行预览。

编辑器功能

  • 编辑器采用了 Typora 自定义主题 Alise.css,有兴趣可以去 Typora Theme 官网查看更多的主题

  • 编辑器最后采取的是左编辑右预览的界面,纯编辑和纯预览或者是全屏展示需要进一步完善...

  • 加粗、倾斜、删除线等功能可以包裹文字,实现对应特效

  • 还可以通过点击按钮实现无序列表和有序列表、任务清单、已完成任务的编辑

  • 图片和超链接,可以通过点击按钮实现,再编辑文字和超链接即可在右侧展示对应效果

  • 代码块,写了一些常见的代码块名称,如果里面的要求不能实现可以自己用```包裹

  • 下载和上传md文件,上传后将会直接替代当前在编辑的MD,请谨慎上传,同时支持下载当前MD到本地

待实现的功能

  • 切换主题
  • 切换 MD 预览风格

About

前后端分离项目 react + ts前端

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors