这篇文章主要讲解了“AntdSite是什么”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“AntdSite是什么”吧!
AntdSite(AntDesignOfSite)是一个基于[AntDesign](Theworld'ssecondmostpopularReactUIframework),由GatsbyJs驱动的一个网站生成器(你可以完全不会这两项技术,只需要会markdown的基础知识,然后简单配置,就能搭建一个网站。当然,如果你会这两项技术那更好)。文档的配置参考了基于vue的文档生成器-[vuepress](ConfigReference|VuePress)。
AntdSite的由来
以前我是vuepress的用户,在开发vue组件中使用它来写文档感觉非常顺手。后来我开始研究上了react,开发react组件就得有文档呀,我在这期间陆续试了几个基于react的文档生成器,像docz,docusaurus.但是试用了下,感觉都不如vuepree顺手。后来,我访问[AntDesign](AntDesign-一个UI设计语言)官网的时候突然冒出来一个想法:把AntDesign官网做成可配置可以吗?答案是可以的。于是,antdsite就诞生了。
总的来说就是把antd官网改成可配置的了。
AntdSite的特点
跟vuepress相仿的配置。上手简单。只需要掌握markdown基础知识和一点js只是就能上手。
可以在markdown里写jsx,还能在里面直接使用全部antdesign组件。参考文档:[使用jsx](在Markdown中使用JSX|AntdSite)
支持自定义部分布局,例如头部,尾部,首页等。支持自定义全部布局。参考文档:[自定义主题](自定义主题|AntdSite)
快速开始
使用cli快速初始化一个项目
yarnglobaladdantdsite-cli
#或者如果你使用npm
npmiantdsite-cli-g
antdsitemy-docs
然后访问本地8000端口就可以啦。
常见问题
这个和vuepress配置完全一样的吗?
大部分是模仿的vuepress的配置的,但也有一些不同。比如配置中没有自定义端口,地址,PWA等。那些需要配置Gatsby的,交给AntdSite反而更加繁琐。
感谢各位的阅读,以上就是“AntdSite是什么”的内容了,经过本文的学习后,相信大家对AntdSite是什么这一问题有了更深刻的体会,具体使用情况还需要大家实践验证。这里是亿速云,小编将为大家推送更多相关知识点的文章,欢迎关注!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。