@ankhorage/paradox (英语)
TypeScript 包的决定性文档生成器.
使用量
国 际
Ankhorage 包通过命令行界面曝光 ankh启用 ankh --help 来发现可用的软件包命令,或用 --help 用于特定软件包.
# Install the Ankhorage CLI
bun add --global @ankhorage/ankh
# Show usage information for paradox
ankh paradox --help
基本用途
Paradox从犬类包结构生成文档. 使用文件寿命
仅在下文 examples/** 或者说 src/cli/**。存储库可能包含多个 @usage
实例,但以下确切的一个例子 examples/** 升级到 README 中 @readme。 。 。 .
README促进的用法提供了明确的 @title 与无空道相. 代码总是来自
真实源声明,而不是在 Paradox 注释中重复代码块.
export const basicConfig = defineParadoxConfig({
mode: 'safe',
});
配置
为软件包配置 Paradox 文档生成 .
配置选项
| 外地 | 类型 | 需求 | 默认 | 说明 |
|---|---|---|---|---|
| 模式 | 'safe' | 'write' | undefined | 没有 | —— 说 | |
| 协作者 | true | undefined | 没有 | —— 说 | |
| 捐赠 | { account: string; } | undefined | 没有 | —— 说 | |
| 文档 | { title?: string; description?: string; } | undefined | 没有 | —— 说 | |
| 软件包 | { root?: string; entrypoints?: string[]; } | undefined | 没有 | —— 说 | |
| 产出 | { dir?: string; } | undefined | 没有 | —— 说 |
生成的文件
公共 API
配置
定义 Paradox 连接
defineParadoxConfig(config: ParadoxConfig) => ParadoxConfig
定义一个 Paradox 配置对象而不改变其形状.
模块 : src/config/defineParadoxConfig.ts
资料来源: src/config/defineParadoxConfig.ts:8:1
相关符号 : ParadoxConfig
文档
帕拉多克-多克-塔斯
支持由 Cononical 文件规则提供者预测的 Paradox 文件标记 .
模块 : src/doc-tags/registry.ts
资料来源: src/doc-tags/registry.ts:33:14
类型
配置
为软件包配置 Paradox 文档生成 .
模块 : src/types/config.ts
资料来源: src/types/config.ts:9:1
合作者
捐款
如果这个项目对您有用,您可以支持它的持续发展.