papyr
A single-page web app for visualising API references.
Last updated 8 years ago by killdream .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install papyr 
SYNC missed versions from official npm registry.

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.

Current Tags

  • 0.1.1                                ...           latest (8 years ago)

2 Versions

  • 0.1.1                                ...           8 years ago
  • 0.1.0                                ...           8 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 1
Last Month 1
Dependencies (15)
Dev Dependencies (0)
None
Dependents (1)

Copyright 2014 - 2016 © taobao.org |