javascript - Stencil JS 的文档生成器
问题描述
我正在使用 Stencil JS 创建自定义 Web 组件。有一次,我遇到了为创建的自定义 Web 组件生成文档的要求。我尝试过生成的文档很少,例如 typedoc 和 docsify。Typedoc 似乎是一个不错的选择,但它会生成静态网站。在我的要求中,我更喜欢让用户动态更改代码的值并在使用之前对其进行预览。为此,我找到了 CodeMirror。有没有办法将 CodeMirror 与 TypeDoc 集成,让用户编辑实时代码并查看 Web 组件中的更改。
如果有任何其他插件或生成器可以完成这项工作,请提出建议。
谢谢
解决方案
我正在做一些可能会有所帮助的事情。目前它有点实验性,更类似于 Storybook,而不是像 TypeDoc 这样的文档工具,尽管我也会在这个方向上做更多的工作。这些组件都是在 StencilJS 中构建的 Web 组件,因此文档可以成为使用它所记录的组件的任何项目的一部分,而不是一个单独的流程。
推荐阅读
- javascript - 具有“经典”功能的闭包计数器不起作用,但使用 IIFE 可以。为什么?
- javascript - 无法使用 Express 和 Node Js 打开从服务器下载的 pdf 文件
- go - 使用 req.Body 中的值更新内存中的对象
- javascript - WordPress 将元素注入 wp.element.createElement
- python - Ansible 将 int 转换为 float
- python - 如何更新表的所有行中的列?
- python - 使用依赖于另一列的布尔值创建一个新的 Pandas df 列
- django - Django 自动测试不适用于 heroku postgresql 数据库
- java - 在java中发送带有正文的post请求
- google-bigquery - bigquery ORDER BY 子句使用哪种排序算法?