Vuepress：将 js 文件注释转为 markdown

目录

一、安装

二、查看版本

三、使用

1、命令

2、目录结构

3、 markdown 文件

四、其它

---

一、安装

npm i vuepress-jsdoc -g

二、查看版本

检查是否安装成功

vuepress-jsdoc -V

下图可以看出我本机是 3.2.0 

 

三、使用

1、命令

输入如下命令即可。这里我们简写了。

• source 是指定当前目录下哪个文件夹下的 js 和 vue 文件需要被转换。它会自动向子文件夹寻找。
• 转换后的文件默认放在 documentation/code 下，找到你的同名markdown 文件即可。

vuepress-jsdoc --source ./src

注意：source 必须指定文件夹，不能这样写。否则会无限循环的生成 documentation/code 文件夹，且难以删除。

vuepress-jsdoc --source ./

2、目录结构

3、 markdown 文件

 

四、其它

vuepress-jsdoc

• 还可以将 vue 和 typescript 文件转为 markdown，但 typescript 需要装相关依赖，这里不做说明，可自行查看文档。
• 会自动生成 config.js 文件，按照原文件结构组织 vuepress 的文件结构。暂不描述，可自行研究。
• 详细的命令参数说明如下：

参考：https://github.com/ph1p/vuepress-jsdoc