Giter VIP home page Giter VIP logo

wadl2wiki's Introduction

Stories in Ready

WADL to WIKI

WORK IN PROGRES

A simple WADL 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 wadl2wiki

Usage

As a command line script

wadl2wiki example.wadl > example.txt
wadl2wiki -i example.wadl -o example.txt
wadl2wiki -s -i example.wadl -o example.txt

Using your own templates:

wadl2txt -t custom-template.handlebars -r custom-resource.handlebars -m custom-item.handlebars -i example.wadl -o example.txt

Example Output

Start of Wiki Page

Start of Wiki Page

Example Endpoint Section

Example Endpoint

This script uses the parsing method and wadl2json script by Rodolphe Belouin (https://github.com/rbelouin/wadl2json)

wadl2wiki's People

Contributors

schrepfler avatar codeblockscreative avatar waffle-iron avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.