Skip to content

tabzzz1/mini-markdown

Repository files navigation

mini-markdown-editor 迷你 markdown 编辑器

采用 pnpm + monorepo 进行管理

目录结构

- docs 文档
- packages
    - mini-markdown-ast-parser markdown 编辑器 ast 解析器(采用 rollup + ts 开发)
    - mini-markdown-editor 编辑器(采用 react + vite 开发、打包)
    - mini-markdown-material 编辑器物料组件库(react + vite 开发、打包)
    - mini-markdown-play 物料组件库测试项目
- scripts 脚本

命令

请使用 pnpm@7 进行依赖安装

# 安装依赖
pnpm in
# 清空项目 node_modules 和 dist 目录
pnpm clear
# 运行 mini-markdown-ast-parser
pnpm dev:ast
# 构建 mini-markdown-ast-parser
pnpm build:ast
# 构建 mini-markdown-ast-parser 案例项目
pnpm build:ast:play
# 运行 mini-markdown-editor
pnpm dev:editor
# 构建 mini-markdown-editor
pnpm build:editor

git提交规范

  1. 需要全局安装 commitizen
pnpm add -g commitizen
  1. 切换到自己的分支
git checkout dev_xxx
  1. 添加文件到暂存区
git add .
  1. 将暂存区的文件提交到本地仓库

git cz 命令代替 git commit,eslint 校验通过后,才能进行后续操作

git cz
  1. 推送到远程仓库
git push origin dev_xxx