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