papyr

0.1.1 • Public • Published

Papyr°

Papyr° is a single-page web application for visualising API documentation written as plain JSON. It can also mix-in examples and Markdown-written content (with just-in-time client-side rendering too!)

Getting Started

Getting your API documentation in 5 easy steps:

  1. Install it from NPM:
$ npm install -g papyr
  1. Create a JSON file describing your documentation:
$ cat > doc.json
{ "project""Test"
"version""1.0.0-snapshot"
"template""default.jade"
"output""docs/build"
"apis": [{ "licence""MIT"
           , "repository""http://github.com/you/test"
           , "examples""examples/"
           , "entities": [ "test.json" ] }]}
  1. Put your API JSON files in the source folder you specified in the previous step.
$ cp ~/path/to/test.json test.json
  1. Run the build step specifying the documentation JSON.
$ papyr build doc.json
  1. Open the index.html file in your browser.

How does that JSON looks?

The JSON should be a list of Objects that match the interface Entity, as described in docs/api.doll. Fields besides id, name, kind and text are optional:

Licence

MIT/X11.

/papyr/

    Package Sidebar

    Install

    npm i papyr

    Weekly Downloads

    1

    Version

    0.1.1

    License

    MIT

    Last publish

    Collaborators

    • killdream