0.2.2 • Published 7 years ago
raml2wiki v0.2.2
RAML to WIKI
A simple RAML to Wiki (Confluence / JIRA Markup) documentation generator, written for Node.js.
Confluence / Jira wiki Process
Output can be pasted into Confluence, using the Insert Markup feature;
Install
npm i -g raml2wiki
Usage
As a command line script
raml2wiki example.raml > example.txt
raml2wiki -i example.raml -o example.txt
raml2wiki -s -i example.raml -o example.txt
Example Output
Start of Wiki Page
Example Endpoint Section
You can add the -p flag in order to use an alternative template where resources are in collapsed panels, as per the below image;
This script uses the parsing method and raml2obj script by Kevin Renskers (https://github.com/raml2html/raml2obj)