当前位置: 首页 > 知识库问答 >
问题:

vue.js - 在线等,是否有实现并落地vue组件文档自动生成的方案?

通鸿风
2023-08-04

目前需要去整理项目中封装的组件,想问一下是否有实现的组件文档自动化生成方案,感谢大佬们!

共有2个答案

东门城
2023-08-04

1.Vue Styleguidist
Vue styleguidist 这个可以根据你的源代码声明和自述文件里的注释给你的组件生成文档。
企业微信截图_16911397042763.png
企业微信截图_16911399102212.png

袁鹤轩
2023-08-04

我之前是读取目录下所有文件后,分析组件属性和类型,再转换成 md 文档。但是没有生成 html 页面,直接就把 markdown 文档放在项目目录里面了。

其实最好是按照现在的开源组件库的方式(比如说 Vant Weapp)。一个组件目录下面一个 readme.md 文件,然后使用HTML静态生成器来自动生成文档和静态站点。可以从他们的 Github Actions 里面看到 pages 的构建脚本。

具体可以看他们的这个项目 Vant CLI,里面就提到了我上面说的组件目录结构。

 类似资料:
  • 安装配置KnpSnappyBundle扩展 先安装扩展,执行: composer require knplabs/knp-snappy-bundle 再安装wkhtmltopdf工具 wget http://download.gna.org/wkhtmltopdf/0.12/0.12.3/wkhtmltox-0.12.3_linux-generic-amd64.tar.xz xz -d wkh

  • 本文向大家介绍Vue结合原生js实现自定义组件自动生成示例,包括了Vue结合原生js实现自定义组件自动生成示例的使用技巧和注意事项,需要的朋友参考一下 就目前三大前端主流数据驱动框架(vue,ng,react)而言,均具有创建自定义组件的api,但都是必须先做到事先写好挂载点,这个挂载点可以是原有静态元素标签也可以是自定义模板;对于多种组件通过同一数据流生成的,如果事先在页面上写好挂载点(moun

  • vue怎么自动生成路由?在view目录下新建文件就行了

  • An expert is someone who is one page ahead of you in the manual. — David Knight 像大多数工程师一样,我从来没有阅读过手册,除非或者直到产品实际出现了十万火急的情况。 然而,随着你的配置清单代码不断增多且越来越复杂,使用 Puppet 的自动文档工具 puppet doc 为你的节点(node)和类(class)生成 H

  • 问题内容: 我正在尝试使用Sphinx为我的代码库自动生成基本文档。但是,我很难指示Sphinx递归扫描我的文件。 我有一个带有文件夹结构的Python代码库: 我在中运行了sphinx-quickstart ,所以现在我的结构如下: 我已经阅读了快速入门教程,尽管我仍在尝试理解文档,但措辞的方式让我担心Sphinx假设我将为代码库中的每个模块/类/函数手动创建文档文件。 但是,我确实注意到了“

  • 此功能将提供一个比较漂亮的接口文档页面,可提供给客户使用。 在easyopen-configuration下找到markdowndoc文件夹,将整个文件夹复制到一个地方,比如D:/盘下,D:/markdowndoc 运行D:/markdowndoc下的run.bat 在IndexController中新增一句配置:apiConfig.setMarkdownDocDir("D:/markdowndo