raml-leanlabsio/raml2html

该包的最新版本(0.0.6)没有提供许可证信息。

PHP RAML 到 HTML 文档生成器

0.0.6 2016-01-30 14:50 UTC

This package is not auto-updated.

Last update: 2024-09-14 17:43:04 UTC


README

更多文档: http://raml2html.leanlabs.io/

生成的示例文档

安装

通过源代码

$ git clone git@github.com:raml-leanlabsio/raml2html.git && cd raml2html && composer install --no-dev

通过二进制文件

下载最新稳定版本 raml2html.phar

用法

作为二进制文件

./raml2html generate -i example/raml/basic/api.raml -o index.html

作为 Docker 镜像

假设在包含 RAML 文件的项目目录中执行命令

docker run  \
   -v `pwd`:/data \
   leanlabs/raml-doc-builder \
   generate --input=input.raml --output=doc.html

选项

  • -i, --input 输入文件 RAML 基础文件(必需)
  • -o, --output 输出文件 "index.html"(必需)

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

贡献

有关详细信息,请参阅 CONTRIBUTING

许可证

MIT 许可证(MIT)。有关更多信息,请参阅 许可证文件

依赖项