redoc - 如何将 Redoc 发布到 gh-pages

Question

我已经使用 redoc 以及所有格式完成了文档的创建。现在我想在 github 页面上发布它。

有一种方法可以使用以下命令生成静态 html 页面 -

npx redoc-cli bundle demo/openapi.yaml

但是这种方法的一个问题是 - 它不保留格式。

有什么方法可以在 gh-pages 上发布所有格式的文档

score 0 · Accepted Answer

我不太确定“格式化”是什么意思。

为了在 github 页面上发布任何内容，您必须拥有静态文件。正确的？

对我有用的解决方案。

从文档页面redoc/quickstart/html/ 获取html 模板在该页面上
，除了 json api doc 之外，您拥有所需的一切

您可以使用命令将您的 yaml api 定义转换为 json bundle。只需在带有的目录中运行此命令<your_api_definition>.yaml，例如我的命令：

docker run --rm -v $(pwd):/spec redocly/openapi-cli bundle  --output openapi --ext json openapi.yaml

在此之后，您应该为自己获取一个 json api 定义——openapi.json 现在将这两个文件添加到您的存储库并配置 github 页面。这就对了。

1 回答 1