基于 vuese
使用方式同vuese,命令替换为hjtvuese,配置文件将会读取 .hjtvueserc 或 hjtvuese.config.js
npm install @hjtvuese/cli -D 或 yarn add @hjtvuese/cli -D
npx hjtvuese gen
或者写入package.json中
"scripts": {
"docs": "hjtvuese gen"
}
npm run docs
在根目录创建 .hjtvueserc 或 hjtvuese.config.js
module.exports = {
title: 'xxx组件文档', // 生成组件文档index的title
include: ['**/*.vue'], // 包含的文件
exclude: [], // 排除的文件,node_modules已被默认排除
outDir: './docs', // 文档的输出目录
}
npx hjtvuese serve --open
npx hjtvuese preview ./src/components/CmpA.vue
可使用 *desc
开头的注释来标记自定义markdown描述,显示在抬头位置。在vuese基础上可以写一些自定义的内容,比如组件的使用例子。
需要将注释的位置放在 import
与 export default {}
之间
import xxx from 'xxx';
/**desc
## 组件描述
...
*/
// @group xxx
export default {}
解析后:
解决2个不同位置同名组件覆盖的问题。
组件文件未修改,不会再重新生成md文件