HTML 模板 AsyncAPI 生成器 使用一个 AsyncAPI 反应组件 在引擎盖下.
使用量
安装 AsyncAPI CPI
npm install -g @asyncapi/cli
使用 CLI 生成
如果您使用 AsyncAPI 生成器 v1 或 v2 模板版本
asyncapi generate fromTemplate <asyncapi.yaml> @asyncapi/[email protected]
如果您使用 AsyncAPI 生成器 v2 的模板版本 v3
asyncapi generate fromTemplate <asyncapi.yaml> @asyncapi/[email protected] --use-new-generator
如果使用AsyncAPI生成器 v3 和 AsyncAPI CPI v5 的模板版本 v3.5
asyncapi generate fromTemplate <asyncapi.yaml> @asyncapi/[email protected]
您可以替换 <asyncapi.yaml> 本地路径或 URL 指向 任意 AsyncAPI 文档。 。 。 .
调查 释放 的模板,以获取所需的版本。 不建议在生产中总是使用最新产品。 总是使用特定版本.
支持参数
| 名称 | 说明 | 需求 | 默认 | 允许的值 | 示例 |
|---|---|---|---|---|---|
| 侧边栏组织 | 定义侧边栏的排列方式。 设定其值为 byTagsNoRoot 以操作标记对操作进行分类。 设定其值为 byTags 当根位上有标记时。 这些标记用于给标记导航建模,在操作中需要同样的标记. | 没有 | 未定义 | byTags, (中文(简体) ), byTagsNoRoot | byTagsNoRoot |
| 基数Href | 设置链接和窗体的基础 URL. | 没有 | / | 任意 | /docs |
| 版本 | 覆盖您的应用程序版本 info.version 指定文件中的位置. | 没有 | 版本取自 spec 文件 . | 任意 (单位:千美元)见 Semver 版本(中文(简体) ) | 1.0.0 |
| 单文件 | 将输出设置为带有内部样式和脚本的 html 文件 . | 没有 | false | true, (中文(简体) ),false | true |
| 外页名 | 输出文件的文件名 . | 没有 | index.html | 任意 | asyncapi.html |
| 页:1 | 生成输出 HTML 作为 PDF . | 没有 | false | true, (中文(简体) ), false | true |
| pdf 超时 | 超时(以ms为单位)用于生成PDF. | 没有 | 3万块 | 页:1 | 1 000个 |
| 图像 | 定义用于favion 的 URL/ Path . | 没有 | assets/asyncapi-favicon.ico | 任何有效的 favicon URL/ Path . | "https://studio.asyncapi.com/favicon.ico" |
| 配置 | 内置字符串 JSON 或 JSON 文件路径来覆盖默认的 React 组件配置 。 配置覆盖与默认配置合并使用 JSON 合并补丁 算法. | 没有 | { "show": { "sidebar": true }, "sidebar": { "showOperations": "byDefault" } } | 反应组件的 JSON 配置 | {"show":{"sidebar":false}} |
页:1: 如果您只生成 HTML 网站, 请设置环境变量
PUPPETEER_SKIP_CHROMIUM_DOWNLOAD改为true生成器将跳过下载铬.
发展
HTML-Template 以一个 AsyncAPI 反应组件。关于页面的造型、缺失/已存在的元素的渲染方面的任何改动,请协助 AsyncAPI 反应组件 仓库.
如果您想要修改模板本身, 请遵循 :
-
确保您安装了最新的生成器 :
npm install -g @asyncapi/generator。 。 。 . -
修改模板或其辅助功能.
注: 如果您需要修改
dummy.yml文档以开发您的特性, 打开带有更改的 PR ayncapi/生成器 仓库. -
启用监视器生成输出 :
npm run develop。 。 。 .注: 如果你的改变不明显,这可能是因为
ag使用已安装的html-template所以,你应该使用--install选项- 运行
npm run develop:install - 如果命令失败, 删除缓存
html-template模块并重运行命令
- 运行
-
在浏览器中打开 HTML :
open ./test/output/index.html。 。 。 .
贡献者
感谢这些伟大的人emoji 密钥:
本项目遵循 全部贡献者 规格。 任何捐款都欢迎!