@bud-fe/docs-gen-cli v0.1.1

@bud-fe/docs-gen-cli

一个 node cli 工具，可以扫描指定目录下的所有 index.tsx 文件，解析每个文件顶部约定好的注释内容，在当前目录生成一份 markdown 文档。

🔨 使用

在项目根目录执行：

$ npx @bud-fe/docs-gen-cli src/pages

随后会在当前目录生成一份 DOCUMENT.md。

约定的注释格式

/**
 * 功能模块-页面名称
 * @remarks
 * TODO: 额外说明
 */