0.0.5 • Published 1 year ago
@es-pkg/doc v0.0.5
@es-pkg/doc
根据ts文件的注释生成表格md
📦 Installation
npm install @es-pkg/doc🏠 Exports
| 参数 | 类型 |
|---|---|
| 🔖default | References |
| 🧷DocOptions | Type Aliases |
| 🎗️bootstrap | Functions |
🔖References
default
Renames and re-exports bootstrap
🧷Type Aliases
生成doc文档的配置项
DocOptions
| 参数 | 类型 | 说明 | 默认值 |
|---|---|---|---|
| author | ?: string | 作者 | |
| caseDir | ?: string | 生成用法 例子的目录 | case |
| desc | ?: string | 描述 | |
| entry | : string | 编译文件的入口 | |
| keepHtmlTable | ?: boolean | 是否保留为原始htmlTable | false |
| name | ?: string | 包名称 | |
| outDir | : string | 编译后输出的文件夹 | |
| outName | ?: string | 编译后输出的文件名称 | README |
| outType | ?: "html" | "md" | ["html", "md"] | 编译后输出的类型 | md |
| repository | ?: string | 仓库地址 | |
| tsconfig | ?: string | 编译文件的 ts配置路径 |
🎗️Functions
bootstrap
默认 EsPkgDoc的主函数
bootstrap(config:
DocOptions):Promise<void>