前段时间搭建了一个组件库,但是缺点很明显,缺少文档,让使用者以及组件库的开发者都不知所以
所以这段时间研究了下,写一个组件库的文档,调研了下市场上的文档生成库,大多数都有自己的文件目录,必须按照它们的规则组织组件库项目的目录,有些没有这些要求,但是功能很弱,所以我想自己写一个类似的文档生成库,对项目目录的要求完全依照我现有的结构来写
对于文档,我想有下面这些功能:
- 可以在页面渲染 markdown
- markdown 中可以嵌套 react 组件
- 直接渲染 markdown 中的 react 代码块
- 在下方展示已渲染的React组件时,同步配套提供该组件的源代码,允许用户进行编辑。编辑操作一经完成,系统即时启动编译流程,以确保上方呈现的组件实例能够快速反映出代码变更的效果,实现预览与编码的无缝衔接。
目前所有功能均已实现 接下来我想将我的研究写成文档,记录下来,也趁机整理代码,然后真正运用到我的组件库中。
我的文章都会更新到掘金账号中,这是我的掘金主页:慢功夫