@doc-kit/cli
命令行接口 医生数字 :
页:1 doc-kit 运行该程序的二进制
@doc-kit/core 要转动的引擎
API形状的Markdown被编成文档网站,JSON,人页等.
使用量
npx @doc-kit/cli --help
npx @doc-kit/cli generate --help
您必须通过命令行提供输入和至少一个目标
选项或配置文件。 配置自动被发现
使用 cosmiconfig,或者您可以明确选择一个文件
--config-file。 。 。 .
npx @doc-kit/cli generate \
-t html \
-i "path/to/docs/**/*.md" \
-o out
内建的生成器名称 @doc-kit/core
发电机 及其伴侣
发电机包,必须安装在这个包上。 自定义
通过导入指定符加载发电机——任何默认导出为
发电机作为 --target。 。 。 .
为了验证本地输出, preview 服务于HTTP——内置
服务器只用于本地测试,不是生产级别。 通过
任意 generate 选项先构建;否则现有的输出目录
(单位:千美元)./out (默认情况下)作为实际值.
npx @doc-kit/cli preview --host localhost --port 3000
捐款
这个包裹住在 节点/doc- kit
单相机。 从此目录( 或寄存器根)
npm run <script> --workspace @doc-kit/cli:
# Run the CLI
npm run run -- generate --help
# Re-run the CLI on every change
npm run watch