前端组件库的文档是用什么写的

北京最好白癜风医院哪家好 http://www.bdfyy999.com/index.html

AntDesign这样的UI组件库,除了自身功能完善,良好的文档支持,也是开发者乐于使用的一大原因。

如标题,类似AntDesign的组件库文档,到底是用什么写的呢?(注意,我们本次讨论的是文档书写,而非组件本身)??

这里得先定义下,我们想要的文档,需要哪些必要元素?

真实组件的渲染,可交互,最好能直接复制代码支持markdown列出组件的所有属性(API),包括类型、说明、默认值等

按照这个目标,搜罗到市面上的现有的相关框架,有下面这些:

dumibishengstorybook[2]gitbookvuepressdocsify

考虑到dumi和AntDesign是React开发,以及蚂蚁的背景,这次我们拿dumi来一探究竟,看能否实现我们想要的东西。

文章较长,建议先点赞、收藏。??

0、一些你可能需要的前置知识(别点,用到时可以回来看??)dumi


转载请注明:http://www.aierlanlan.com/rzdk/328.html