Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raml2html/raml2md
*DEPRECATED* RAML to Markdown documentation generator.
https://github.com/raml2html/raml2md
Last synced: about 2 months ago
JSON representation
*DEPRECATED* RAML to Markdown documentation generator.
- Host: GitHub
- URL: https://github.com/raml2html/raml2md
- Owner: raml2html
- License: mit
- Created: 2014-06-12T22:54:27.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-02-13T22:57:45.000Z (almost 8 years ago)
- Last Synced: 2024-04-20T10:28:23.884Z (9 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.org/package/raml2md
- Size: 63.5 KB
- Stars: 72
- Watchers: 6
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# DEPRECATED
Please use raml2html 5.x with the raml2html-markdown-theme instead.
# RAML to Markdown
[](https://www.npmjs.org/package/raml2md)
[](https://github.com/airbnb/javascript)
A simple RAML to Markdown documentation generator, written for Node.js.
Check [raml2html](https://github.com/raml2html/raml2html) for a RAML to HTML generator.
## RAML version support
raml2md 4 and higher only support RAML 1.0 files. Please stick with raml2md 3.x for RAML 0.8 support.
## Install
```
npm i -g raml2md
```
## Usage
### As a command line script
```
raml2md example.raml > example.md
raml2md -i example.raml -o example.md
raml2md -t examples/custom-template-test/template.nunjucks -i examples/example.raml -o example.md
```
### As a library
#### Using the default templates
```js
var raml2md = require('raml2md');
var config = raml2md.getDefaultConfig();
// source can either be a filename, file contents (string) or parsed RAML object.
// Returns a promise.
raml2md.render(source, config).then(function(result) {
// Save the result to a file or do something else with the result
}, function(error) {
// Output error
});
```
#### Using your own Nunjucks templates
```js
var raml2md = require('raml2md');
var config = raml2md.getDefaultConfig('my-custom-template.nunjucks', __dirname);
raml2md.render(source, config).then(...);
```
#### Custom pre-processing
```js
var raml2md = require('raml2md');
var config = raml2md.getDefaultConfig();
config.processOutput = function(data) {
// Do whatever you want here and return the modified data.
// The default implementation:
return data.replace(/\n{3,}/g, '\n\n');
};
raml2md.render(source, config).then(...);
```
If you want to use a different template language, you're better off directly using [raml2obj](https://github.com/kevinrenskers/raml2obj).
## RAML version support
raml2md 4 and higher only support RAML 1.0 files. Please stick with raml2md 3.x for RAML 0.8 support.
## Contribute
raml2md is an open source project and your contribution is very much appreciated.
1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
2. Fork the repository on Github and make your changes on the **develop** branch (or branch off of it).
Please retain the [code style](https://github.com/airbnb/javascript) that is used in the project and `npm run lint` before committing.
3. Add an example of the new feature to example.raml (if applicable)
4. Send a pull request (with the develop branch as the target).
A big thank you goes out to everyone who helped with the project, the [contributors](https://github.com/raml2html/raml2md/graphs/contributors)
and everyone who took the time to report issues and give feedback.
## License
raml2md is available under the MIT license. See the LICENSE file for more info.