衆所周知,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