Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cybertk/grunt-raml2html
Compile RAML to HTML
https://github.com/cybertk/grunt-raml2html
Last synced: 2 months ago
JSON representation
Compile RAML to HTML
- Host: GitHub
- URL: https://github.com/cybertk/grunt-raml2html
- Owner: cybertk
- License: mit
- Created: 2014-09-30T06:20:49.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-05-31T21:36:57.000Z (over 7 years ago)
- Last Synced: 2024-10-11T12:19:40.912Z (3 months ago)
- Language: CoffeeScript
- Homepage:
- Size: 36.1 KB
- Stars: 12
- Watchers: 4
- Forks: 6
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## grunt-raml2html
> Compile RAML to HTML
[](https://www.npmjs.com/package/grunt-raml2html)
[](https://travis-ci.org/cybertk/grunt-raml2html)
[](https://david-dm.org/cybertk/grunt-raml2html)
[](https://david-dm.org/cybertk/grunt-raml2html#info=devDependencies)
[](https://github.com/semantic-release/semantic-release)
## Getting Started
This plugin requires Grunt `~0.4.5`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-raml2html --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-raml2html');
```
## The "raml2html" task
### Overview
In your project's Gruntfile, add a section named `raml2html` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
raml2html: {
all: {
options: {
// Task-specific options go here.
},
default: {
// Target-specific file lists and/or options go here.
}
}
},
});
```
### Options
#### options.separator
Type: `String`
Default value: `', '`
A string value that is used to do something with whatever.
#### options.punctuation
Type: `String`
Default value: `'.'`
A string value that is used to do something else with whatever else.
### Usage Examples
#### Default Options
In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`
```js
grunt.initConfig({
raml2html: {
all: {
files: {
'dest/api.html': ['api.raml'],
}
}
},
});
```
#### Custom Options
In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`
```js
grunt.initConfig({
raml2html: {
all: {
options: {
separator: ': ',
punctuation: ' !!!'
},
files: {
'dest/api.html': ['src/github.raml'],
}
}
},
});
```
#### Custom Template
Custom templates can be loaded using the following. Both mainTemplate and templatesPath are required in this case. Other templates, such as resource.nunjucks and item.nunjucks are now seen as part of the main template. Therefore they cannot be set individually.
```js
grunt.initConfig({
raml2html: {
all: {
options: {
mainTemplate: 'template.nunjucks',
templatesPath: './my/custom/path'
},
files: {
'dest/api.html': ['src/github.raml'],
}
}
},
});
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
[](https://bitdeli.com/free "Bitdeli Badge")