前言
簡(jiǎn)介
AntdSite(Ant Design Of Site) 是一個(gè)基于[Ant Design](The world's second most popular React UI framework)寡润，由GatsbyJs驅(qū)動(dòng)的一個(gè)網(wǎng)站生成器 (你可以完全不會(huì)這兩項(xiàng)技術(shù)，只需要會(huì) markdown 的基礎(chǔ)知識(shí)墩朦，然后簡(jiǎn)單配置颜骤，就能搭建一個(gè)網(wǎng)站郁副。當(dāng)然衰伯，如果你會(huì)這兩項(xiàng)技術(shù)那更好)。文檔的配置參考了基于 vue 的文檔生成器 - [vuepress](Config Reference | VuePress)痹筛。
由來(lái)
以前我是vuepress的用戶氨肌，在開發(fā) vue 組件中使用它來(lái)寫文檔感覺非常順手鸿秆。 后來(lái)我開始研究上了 react，開發(fā) react 組件就得有文檔呀怎囚，我在這期間陸續(xù)試了幾個(gè)基于 react 的文檔生成器卿叽，像docz, docusaurus . 但是試用了下，感覺都不如 vuepree 順手恳守。后來(lái)考婴，我訪問(wèn)[Ant Design](Ant Design - 一個(gè) UI 設(shè)計(jì)語(yǔ)言)官網(wǎng)的時(shí)候突然冒出來(lái)一個(gè)想法： 把Ant Design官網(wǎng)做成可配置可以嗎？ 答案是可以的催烘。于是沥阱，antdsite就誕生了。
總的來(lái)說(shuō)就是把 antd 官網(wǎng)改成可配置的了伊群。
特點(diǎn)
- 跟 vuepress 相仿的配置考杉。上手簡(jiǎn)單策精。只需要掌握 markdown 基礎(chǔ)知識(shí)和一點(diǎn) js 只是就能上手。
- 可以在 markdown 里寫
jsx, 還能在里面直接使用 全部 ant design 組件崇棠。 參考文檔：[使用 jsx](在 Markdown 中使用 JSX | AntdSite) - 支持自定義部分布局咽袜，例如頭部，尾部易茬，首頁(yè)等酬蹋。支持自定義全部布局及老。參考文檔：[自定義主題](自定義主題 | AntdSite)
快速開始
使用 cli 快速初始化一個(gè)項(xiàng)目
yarn global add antdsite-cli
# 或者如果你使用npm
npm i antdsite-cli -g
antdsite my-docs
然后訪問(wèn)本地8000端口就可以啦抽莱。
常見問(wèn)題
這個(gè)和 vuepress 配置完全一樣的嗎？
大部分是模仿的 vuepress 的配置的骄恶，但也有一些不同食铐。比如配置中沒有自定義端口，地址,PWA 等僧鲁。 那些需要配置Gatsby的虐呻，交給 AntdSite 反而更加繁瑣。
我不會(huì) react 可以使用嗎寞秃？
完全可以斟叼。上手的要是是僅僅是 markdown 基礎(chǔ)知識(shí)和一點(diǎn) js 知識(shí)。
可以將自定義主題做成插件形式發(fā)布到 npm 上嗎春寿？
這個(gè)暫時(shí)不可以朗涩，不過(guò)未來(lái)可以考慮加入這個(gè)功能。
如果還有問(wèn)題可以留言一起討論～
