前言
以前開發vue組件時，寫文檔使用的是vuepress，之後轉戰react後覺得沒有順手的文檔生成工具，就模仿vuepress寫了這個rcpress。
特點
- RcPress 是一個基於 React.js 的靜態文檔生成器。
- 文檔UI是模仿 ant design 官網
- 功能配置模仿Vuepress
- 支持mdx，可以在markdown中使用jsx。
- 支持service worker。
- 生產模式下支持生成靜態html頁面和打包spa兩種模式。
- 開發模式下支持ssr，spa兩種模式。
技術棧
快速上手
安裝
安裝命令行工具 @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打包。