docs ts:我的TypeScript项目的零配置文档工具 源码

目录 一个简单,自以为是的零配置工具,用于为TypeScript项目创建漂亮的文档。 安装: 通过npm npm install -D docs-ts 通yarn yarn add -D docs-ts 通过npx (按需) npx docs-ts 为什么 为任何规模的TypeScript项目创建和维护文档都会很快成为一项艰巨的任务。 docs-ts通过允许您将文档及其关联的代码放在一起来简化此过程。 您只需用JSDoc注释注释代码,然后CLI就会生成漂亮的markdown文档,其中包含与代码关联的所有文档和示例。 另外,生成的docs-ts输出可以用作GitHub上存储库文档的。 用法