为了让大家能在vuepress中写react,我开发了rcpress

前言

众所周知,vuepress是一款比较著名的文档生产工具。其特点是功能强大,使用简洁。以前开发vue组件时,写文档使用的就是它,之后转战react后觉得没有类似的顺手的文档工具,就模仿vuepress写了这个rcpress。

  • GitHub 仓库地址: rcpress
  • 文档地址: rcpress

与vuepress的对比

vuepress rcpress
驱动框架 vue react
UI vue主题ui Ant Design
自定义主题
service worker
pwa
定制主题颜色 ✅(Ant Design内置功能)
开发模式hot reload
插件机制
开发模式下运行ssr
打包成单页面
打包成静态html
markdown中写代码 ✅(mdx)

快速上手

安装命令行工具 @rcpress/cli


yarn global add @rcpress/cli

# 或者如果你用npm

npm i  @rcpress/cli -g

创建目录以及markdown文件

# 创建 docs 目录(docs是默认的文档目录)
mkdir docs

#创建markdown文件
echo '# Hello RcPress' > docs/README.md

运行

# 启动spa模式的服务
rcpress dev
# 启动服务端渲染的服务
rcpress server

# 访问`3000`端口即可。

打包构建

# 在生产环境下构建spa
rcpress build
# 在生产环境下构建ssr并且声称静态html文件
rcpress generate

你可能感兴趣的:(前端,文档生成,javascript,antdesign)