Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 1.08 KB

README.md

File metadata and controls

38 lines (22 loc) · 1.08 KB

raml-workflow

Basic RAML workflow that will use RAML2HTML with browserSync to refresh a API doc on change.

Took a bit of running around the web to get a good RAML workflow. Hope this helps save some time.

Install

  • Install: raml2md globaly: npm i -g raml2md
  • Run: npm install

Create your RAML file as api/api.raml OR symlink your current raml folder (if stored in another repo). Output will be in /output for MD and HTML.

Tasks

Markdown Conversion:

Run: npm run build

HTML Conversion:

Run: gulp apidoc

HTML Conversion with Live Reload:

Run: gulp serve

Linting with Fancy Output:

Run: gulp rlint

Dependencies/External Scripts: