RAMbLOn

README

RamblOn

A Go (golang) Interactive RAML v1.0 API to HTML Documentation Generator.

RamblOn allows you to view the generated RAML based Documentation in a browser and it will automatically update when you save your .raml file.

I started using API Workbench to edit RAML 1.0 documents and found there was no great way to generate API documentation.

API Workbench is a great editing tool, what I really wanted was an interactive RAML-->HTML converter that picked up changes as I made them.

I also wanted a more theme-able approach to the documentation generation.

So I built RamblOn using Go for ease of installation (single binary), Martini and a fork of go-raml-parser.

You can run the web server for interactive RAML visualization. The server will watch the RAML directories and use websockets to reload the pages that have changed (or just have docs gen'd on demand, or you can run it as a command line program to generate final documentation.

This project is pretty early, and there is a bunch of work left to do:

1. RAML v1.0 spec completion
2. RAML v1.0 validation
3. SASS setup
4. Websockets update notification
5. Improved CSS
6. Documentation Generation Mode
7. Configuration for port, and RAML directories.
8. Much better directory support :D
9. Better update model
10. Error handling in the preview
11. Add Zip generation.
12. Add toolbar for live preview mode to generate docs, see errors, etc.

My approach to RAML Includes has been to first generate the complete document by dereferencing the includes instead of what @tsaikd did with the yaml post processing.

Pull Requests are encouraged, thanks in advance.

Getting Started

To Run the Live Preview Server:

go get github.com/mattbaird/RAMbLOn
go build 
./RAMbLOn p

Navigate to http://localhost:3000/browse

Click on one of the directories to select a RAML project.

Click on one of the .raml files to select a RAML API Spec.

You should be looking at the base RAML Document that RamblOn generated.

Edit the RAML document, notice it updates in the browser.

To Generate Documentation:

go get github.com/mattbaird/RAMbLOn
go build 
./RAMbLOn g

Your options here include:

--l or --local to generate a file-viewable version --o or --outputdir to set the directory you want to output the docs to