Stencil JS的文档生成器

时间:2018-07-05 04:06:20

标签: javascript documentation web-component stenciljs stencil-component

我正在使用Stencil JS创建自定义Web组件。有时,我遇到了此要求,以为创建的自定义Web组件生成文档。我尝试生成的文档很少,例如typedoc和docsify。 Typedoc似乎是一个不错的选择,但它会生成静态网站。根据我的要求,我更喜欢让用户动态更改代码的值并在使用前对其进行预览。为此,我找到了CodeMirror。有没有一种方法可以将CodeMirror与TypeDoc集成在一起,以便用户编辑实时代码并查看Web组件中的更改。

如果还有其他可以完成此工作的插件或生成器,请提出建议。

谢谢

1 个答案:

答案 0 :(得分:1)

我正在研究可能会有所帮助的东西。目前,它还处于试验阶段,比诸如TypeDoc之类的文档工具更类似于Storybook,尽管我也将朝着这个方向努力。这些组件都是在StencilJS中构建的所有Web组件,因此,无论使用其文档的组件,该文档都可以成为项目的一部分,而不是一个单独的过程。

https://github.com/steveruizok/st-lookbook

Demo

Screenshot