conscribe

Combining JSON Schema and Markdown

npm install conscribe
12 downloads in the last month

conscribe Build Status Dependency Status NPM version

Using a Schema documents to generate a JSON Schema for Validation, Fixture for API Handers, and Channel Specification Documents for CMWAPI. These channels and API's are intended for use in the OWF Platform for communication for between particular widgets.

The issue

In trying to find a solution to combine the CMWA API/ OWF Channels schema and documentation, it was found that JSDOC wasn't quite up to the task of documenting it how we thought it should. This will allow our handlers and documentation to be generated from one document. Furthermore, this will allow us to validate incoming and outgoing traffic from wigets and maps using the same document using JSON Schema.

Getting Started

This will eventually become a node module so that it can be used with CI and build solutions like maven and Jekins.

Install the module with: npm install conscribe (published but not release quality.)

Quickstart


var conscribe = require('conscribe');
conscribe.[yet to be decided]();

node conscribe.js -c [configFile] [-e]

Documentation

Running from commandline

node conscribe.js -c [configFile] [-e]

-c [configFile] : Specify config file to use. (Required)

-e : Generate inital skeleton examples. If used, it will blow away any examples left in directory. (Optional)

Examples

As Module

Commandline

Configuration File

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

0.0.0 : Non-release / planning

License

Copyright (c) 2013 Nicholas Johnson. Licensed under the MIT license.

npm loves you