rcpress-基于React的文档生成器

前言

以前开发 vue 组件时，写文档使用的是 vuepress，之后转战 react 后觉得没有顺手的文档生成工具，就模仿 vuepress 写了这个 rcpress。

特点

• RcPress 是一个基于 React.js 的静态文档生成器。
• 文档 UI 是模仿 ant design 官网
• 功能配置模仿 Vuepress
• 支持 mdx，可以在 markdown 中使用 jsx。
• 支持 service worker。
• 生产模式下支持生成静态 html 页面和打包 spa 两种模式。
• 开发模式下支持 ssr，spa 两种模式。

技术栈

• ReactJs
• Ant Design
• mdx
• remark
• prismjs
• service worker

快速上手

安装

安装命令行工具 @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

文档

获取详细的文档，推荐访问网站上的向导一节。

首页截图

与 vuepress 的对比

首先说下不同点

• rcpress 使用了 react.js 驱动，而 vuepress 是由 vue 驱动的。
• rcpress 是使用了 Ant Design 作为 UI 框架，而 vuepress 是使用了自定义的样式。

说下欠缺的功能

• 没有 plugin(插件) 这个概念，当然以后可以考虑加入。

说下优势

• 可以在文档里使用所有 ant design 的组件，不用自己写。
• 支持在开发模式下运行 spa，ssr 两种模式。vuepress 貌似只能运行 spa 模式。
• 支持生产 spa 打包。

相关链接

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