raml2html中文文档|raml2html js中文教程|解析

一个简单的 RAML 到 HTML 文档生成器，为 Node.js 编写，具有主题支持。

RAML 版本支持

raml2html 4 及更高版本仅支持 RAML 1.0 文件。请坚持使用 raml2html 3.x 以获得 RAML 0.8 支持。

安装

npm i -g raml2html

主题

raml2html 附带一个默认主题，但您可以从 NPM 安装更多主题。例如，要将 RAML 呈现为 Markdown，您可以安装 raml2html-markdown-theme 主题：

npm i -g raml2html-markdown-theme

在 NPM 中搜索“raml2html-theme”关键字（或使用此链接）以查找更多主题。

用法

作为命令行脚本

raml2html --help
raml2html example.raml > example.html
raml2html --theme raml2html-markdown-theme example.raml > example.html
raml2html --template my-custom-template.nunjucks -i example.raml -o example.html

作为图书馆

使用默认主题、不同主题或您自己的 Nunjucks 模板

const raml2html = require('raml2html');
const configWithDefaultTheme = raml2html.getConfigForTheme();
const configForDifferentTheme = raml2html.getConfigForTheme('raml2html-markdown-theme');
const configWithCustomTemplate = raml2html.getConfigForTemplate('~/path/to/my-custom-template.nunjucks');

// source can either be a filename, url, or parsed RAML object
raml2html.render(source, configWithDefaultTheme).then(function(result) {
  // Save the result to a file or do something else with the result
}, function(error) {
  // Output error
});

使用您自己的处理功能，完全控制整个渲染过程

/**
 * config should be an object with at least an `processRamlObj` property which is a function that receives the raw RAML
 * object and must return a promise with the result. You can do whatever you want in this function.
 *
 * You can also supply a postProcessHtml function that can for example minify the generated HTML.
 * 
 * You can also supply a writeOutput function that takes over writing the output (to disk for example).
 *
 * You can also supply a setupNunjucks function that takes the env as its only parameter.
 */
raml2html.render(source, config).then(function(result) {
  // Save the result to a file or do something else with the result
}, function(error) {
  // Output error
});

另请参阅example/script.js使用 raml2html 作为库的多个示例。

吞咽

您可以直接从 Gulp使用raml2html。

示例输出

请参阅以下链接以获取实时示例：

• https://rawgit.com/raml2html/default-theme/master/examples/helloworld.html
• https://rawgit.com/raml2html/default-theme/master/examples/world-music-api.html

在您报告错误之前

如果您遇到解析错误，请不要将它们报告给 raml2html：它不会进行实际的 RAML 解析。查看错误并修复您的 RAML 文件，或在raml-js-parser-2 上打开一个新问题。

贡献

raml2html 是一个开源项目，非常感谢您的贡献。

1. 检查未解决的问题或打开新问题以开始围绕功能想法或错误的讨论。
2. 在 Github 上 fork 存储库并在开发分支（或从它的分支）上进行更改。npm run lint在提交之前运行以检查常见问题并自动格式化所有代码。
3. 将新功能的示例添加到 example.raml（如果适用）
4. 发送拉取请求（以开发分支为目标）。

如果您的拉取请求被合并，请随意请求推送访问。我们想要获得更多的维护者！如果您确实有推送访问权限，请仍然在功能分支上工作并创建拉取请求，然后进行审核。您还可以查看其他人的拉取请求并以这种方式参与其中。

非常感谢为该项目提供帮助的每个人、贡献者
以及花时间报告问题和提供反馈的每个人。

本地设置

要获得处理 raml2html 和默认主题的最佳环境，请按照以下步骤操作。

1. 签出 raml2html-default-theme 的开发分支；npm link.
2. 签出 raml2html 的开发分支；先npm link raml2html-default-theme然后npm link。
3. 在 raml2html-default-theme 中运行npm link raml2html。

现在这两个项目都是全局安装的，但使用两者的本地开发版本。从主题存储库的示例文件夹中，您可以render-all-examples毫无问题地运行脚本。

变更日志

见变更日志.md

执照

raml2html 在 MIT 许可下可用。有关详细信息，请参阅许可证文件。