@node-core/doc-kit
的node .js特定的生成器 doc-kit: Node.js消耗的输出 项目自己的构建、发布和文档过程。如果你不是 构建Node.js本身(或者类似的东西),您可能 想要一个吗? 通用发电机 代替。
安装
npm install --save-dev @doc-kit/core @node-core/doc-kit
发电机
| 目标 | 输出 |
|---|---|
man-page | 这个 node.1 手册页中记录的CLI选项 cli.md. |
api-links | API符号到它们的源位置的映射,支持nodejs.org上的源链接。 |
addon-verify | 提取的c++插件代码样本 addons.md,安排由测试进行编译。 |
使用
npx @doc-kit/cli generate -t man-page -i "doc/api/cli.md" -o out
看到 doc-kit文档 用于 配置和完整的生成器引用。