前言
簡介
AntdSite(Ant Design Of Site) 是一個基於Ant Design,由GatsbyJs驅動的一個網站生成器 (你可以完全不會這兩項技術,只需要會 markdown 的基礎知識,然後簡單配置,就能搭建一個網站。當然,如果你會這兩項技術那更好)。文檔的配置參考了基於 vue 的文檔生成器 - vuepress。
由來
以前我是vuepress的用戶,在開發 vue 組件中使用它來寫文檔感覺非常順手。 後來我開始研究上了 react,開發 react 組件就得有文檔呀,我在這期間陸續試了幾個基於 react 的文檔生成器,像docz, docusaurus . 但是試用了下,感覺都不如 vuepree 順手。後來,我訪問Ant Design官網的時候突然冒出來一個想法: 把Ant Design
官網做成可配置可以嗎? 答案是可以的。於是,antdsite
就誕生了。
總的來說就是把 antd 官網改成可配置的了。
特點
- 跟 vuepress 相仿的配置。上手簡單。只需要掌握 markdown 基礎知識和一點 js 只是就能上手。
- 可以在 markdown 裏寫
jsx
, 還能在裏面直接使用 全部 ant design 組件。 參考文檔:使用 jsx - 支持自定義部分佈局,例如頭部,尾部,首頁等。支持自定義全部佈局。參考文檔:自定義主題
快速開始
使用 cli 快速初始化一個項目
yarn global add antdsite-cli
# 或者如果你使用npm
npm i antdsite-cli -g
antdsite my-docs
然後訪問本地8000
端口就可以啦。
運行截圖
常見問題
這個和 vuepress 配置完全一樣的嗎?
大部分是模仿的 vuepress 的配置的,但也有一些不同。比如配置中沒有自定義端口,地址,PWA 等。 那些需要配置Gatsby的,交給 AntdSite 反而更加繁瑣。
我不會 react 可以使用嗎?
完全可以。上手的要是是僅僅是 markdown 基礎知識和一點 js 知識。
可以將自定義主題做成插件形式發佈到 npm 上嗎?
這個暫時不可以,不過未來可以考慮加入這個功能。
如果還有問題可以留言一起討論~