https://github.com/diegogurgel/ramltomd
Convertes RAML to Markdown
https://github.com/diegogurgel/ramltomd
Last synced: 3 months ago
JSON representation
Convertes RAML to Markdown
- Host: GitHub
- URL: https://github.com/diegogurgel/ramltomd
- Owner: diegogurgel
- Created: 2015-03-24T05:20:46.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-10-02T07:29:22.000Z (over 4 years ago)
- Last Synced: 2025-01-11T23:38:53.695Z (5 months ago)
- Language: RAML
- Size: 1.47 MB
- Stars: 5
- Watchers: 3
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Raml to Markdown
A RAML to markdown converter made in nodejs
### Install
```sh
$ npm install -g ramltomd
```
### Usage
#### Comand line
```sh
$ ramltomd -i path/to/filename.raml > path/to/output.md
```
##### Help
```
Usage: ramltomd [options]
Options:
-h, --help output usage information
-V, --version output the version number
-i, --input [path] path for raml file
```
#### As a library
```javascript
var ramlToMd = require('ramltomd');
ramlToMd.render(path).then(function(result){
});
```