众所周知,vuepress是一款比较著名的文档生产工具。其特色是功能强大,使用简洁。之前开发vue组件时,写文档使用的就是它,以后转战react后以为没有相似的顺手的文档工具,就模仿vuepress写了这个rcpress。html
vuepress | rcpress | |
驱动框架 | vue | react |
UI | vue主题ui | Ant Design |
自定义主题 | ✅ | ✅ |
service worker | ✅ | ✅ |
pwa | ✅ | ✅ |
定制主题颜色 | ❌ | ✅(Ant Design内置功能) |
开发模式hot reload | ✅ | ✅ |
插件机制 | ✅ | ❌ |
开发模式下运行ssr | ❌ | ✅ |
打包成单页面 | ❌ | ✅ |
打包成静态html | ✅ | ✅ |
markdown中写代码 | ✅ | ✅(mdx) |
安装命令行工具 @rcpress/cli
vue
yarn global add @rcpress/cli # 或者若是你用npm npm i @rcpress/cli -g
建立目录以及markdown文件react
# 建立 docs 目录(docs是默认的文档目录) mkdir docs #建立markdown文件 echo '# Hello RcPress' > docs/README.md
运行git
# 启动spa模式的服务 rcpress dev # 启动服务端渲染的服务 rcpress server # 访问`3000`端口便可。
打包构建github
# 在生产环境下构建spa rcpress build # 在生产环境下构建ssr而且声称静态html文件 rcpress generate