前言
简介
AntdSite(Ant Design Of Site) 是一个基于Ant Design，由GatsbyJs驱动的一个文档生成器。
使用它的基本要求是会markdown语法。
由来
以前我是vuepress的用户，在开发 vue 组件中使用它来写文档感觉非常顺手。 后来我开始研究上了 react，开发 react 组件就得有文档呀，我在这期间陆续试了几个基于 react 的文档生成器，像docz, docusaurus . 但是试用了下，感觉都不如 vuepree 顺手。后来，我访问Ant Design官网的时候突然冒出来一个想法： 把Ant Design官网做成可配置可以吗？ 答案是可以的。于是，antdsite就诞生了。
总的来说就是：
- 文档的配置模仿了vuepress的配置。
- 文档的界面设计来源于Ant Design的官网。
- 说白了就是Ant Design官网，我给它改成可配置的了，并且让它功能更强大！
特点
- 跟 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 上吗？
这个暂时不可以，不过未来可以考虑加入这个功能。
如果还有问题可以留言一起讨论～
