RAML to Wiki format documentation generator
Switch branches/tags
Nothing to show
Clone or download
Latest commit a69f4ac Aug 3, 2017

README.md

This is now conidered deprecated Please consider using https://www.npmjs.com/package/raml2html-confluencewiki-theme

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;

Wiki menu

Wiki insert

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

Start of Wiki Page

Example Endpoint Section

Example Endpoint

You can add the -p flag in order to use an alternative template where resources are in collapsed panels, as per the below image;

Alternative Template

This script uses the parsing method and raml2obj script by Kevin Renskers (https://github.com/raml2html/raml2obj)