使用docz我們可以用來方便的編寫以及發布文檔,同時提供漂亮友好的交互,可以快速的制作一個產品級的
站點,使用了了mdx 文件(還是markdown),同時可以方便的集成到自己的web 項目中
安裝試用
- 安裝
npx create-docz-app my-docz-app
- 項目結構
├── README.md
├── doczrc.js
├── package-lock.json
├── package.json
└── src
├── components
│ ├── Alert.jsx
│ └── Alert.mdx
└── index.mdx
- 啟動效果
yarn dev
錯誤解決
目前在使用mac 安裝的時候碰到幾個問題
libvips, 主要是 因為依賴sharp 引起的
CXX(target) Release/obj.target/sharp/src/common.o
../src/common.cc:25:10: fatal error: 'vips/vips8' file not found
#include <vips/vips8>
解決方法:
brew install vips
說明
idyll 也是一個類似不錯的東西,但是idyll偏向於科學分析
參考資料
https://github.com/doczjs/docz
https://github.com/idyll-lang/idyll