0.2.2 • Published 9 years ago

raml2wiki v0.2.2

Weekly downloads
5
License
MIT
Repository
github
Last release
9 years ago

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)

0.2.2

9 years ago

0.2.0

9 years ago

0.1.7

10 years ago

0.1.6

10 years ago

0.1.5

10 years ago

0.1.4

10 years ago

0.1.3

10 years ago

0.1.2

11 years ago

0.1.1

11 years ago

0.1.0

11 years ago

0.0.9

11 years ago

0.0.0

11 years ago