在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称:raml2html/raml2html开源软件地址:https://github.com/raml2html/raml2html开源编程语言:JavaScript 100.0%开源软件介绍:A simple RAML to HTML documentation generator, written for Node.js, with theme support. RAML version supportraml2html 4 and higher only support RAML 1.0 files. Please stick with raml2html 3.x for RAML 0.8 support. Install
Themesraml2html ships with a default theme, but you can install more from NPM. For example, to render RAML to Markdown, you can install the raml2html-markdown-theme theme:
Search NPM for the "raml2html-theme" keyword (or use this link) to find more themes. UsageAs a command line script
As a libraryUsing the default theme, different themes, or your own Nunjucks templatesconst 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
}); Using your own processing function, for full control over the whole rendering process/**
* 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
}); See also examples/script.js for multiple examples of using raml2html as a library. Example outputPlease see the following links for live examples:
Before you report a bugIf you get parsing errors, please do not report them to raml2html: it doesn't do the actual RAML parsing. Review the error and fix your RAML file, or open a new issue at raml-js-parser-2. Contributingraml2html is an open source project and your contribution is very much appreciated.
If your pull request is merged feel free to ask for push access. We want to get more maintainers! If you do have push access, please still work on feature branches and create pull requests, which then get reviewed. You can also review other people's pull requests and be involved in that way. A big thank you goes out to everyone who helped with the project, the contributors and everyone who took the time to report issues and give feedback. Local setupTo get the best environment to work on raml2html and the default theme, follow these steps.
Now both projects are installed globally, but using the local development versions of both.
From the theme repo's examples folder you can run the ChangelogSee changelog.md Licenseraml2html is available under the MIT license. See the LICENSE file for more info. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论