【文件属性】:
文件名称:docs:Stargate的文档
文件大小:1.49MB
文件格式:ZIP
更新时间:2021-05-11 11:21:44
HTML
Stargate文档
此存储库包含Stargate文档的源文件。
这些文档以asciidoc编写,并使用Antora生成输出。
Stargate文档分为三个Antora模块:
具有一般项目信息的ROOT模块。
快速入门模块,其中包含入门新用户的基本文档。
开发人员指南模块,其中包含有关Stargate所有功能的更广泛的主题。
依存关系
Antora需要NodeJS,先安装它,然后再安装项目依赖项:
npm install
查看当前HTML输出
docs的当前开发版本已生成并发布在。
.github/workflows/antora.yml GitHub动作将在推送到master分支时生成并发布开发文档。 开发文档使用site-local.yaml Antora站点配置文件。
在本地生成和查看HTML输出
可以在开发过程中本地生成文档,以检查工作。 仅生成文档(如果不需要检查Op