文件名称：docs-ts：我的TypeScript项目的零配置文档工具
文件大小：107KB
文件格式：ZIP
更新时间：2024-03-06 06:40:55
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上存储库文档的。 用法 使用docs-ts就像用JSDoc注释注释代码一样简单。 docs-ts支持指定@category JSDoc标记以在生成的文档中对关联的模块导出进行分组。 您还可以使用@example JSDoc
【文件预览】：
docs-ts-master
----.gitignore(36B)
----package.json(2KB)
----tslint.json(359B)
----package-lock.json(213KB)
----src()
--------FileSystem.ts(4KB)
--------Core.ts(17KB)
--------Logger.ts(4KB)
--------Config.ts(6KB)
--------index.ts(1KB)
--------Parser.ts(26KB)
--------bin.ts(222B)
--------Markdown.ts(15KB)
--------Module.ts(5KB)
--------Example.ts(2KB)
----jest.config.js(519B)
----LICENSE(1KB)
----CHANGELOG.md(4KB)
----tsconfig.json(447B)
----.github()
--------PULL_REQUEST_TEMPLATE.md(337B)
--------ISSUE_TEMPLATE.md(424B)
--------workflows()
----README.md(6KB)
----docs.ts(19B)
----.vscode()
--------settings.json(57B)
----docs()
--------index.md(33B)
--------_config.yml(217B)
--------modules()
----test()
--------FileSystem.ts(5KB)
--------Core.ts(11KB)
--------Logger.ts(3KB)
--------tsconfig.json(423B)
--------Config.ts(5KB)
--------index.ts(1KB)
--------Parser.ts(36KB)
--------utils.ts(610B)
--------Markdown.ts(11KB)
--------Module.ts(4KB)
--------fixtures()
--------Example.ts(1KB)
----.prettierrc(64B)