spacedoc-json v0.3.0

spacedoc-json

JSON Schema adapter for Spacedoc

Parses information from JSON files formatted as JSON Schema. For use with Spacedoc, a documentation generator.

npm install spacedoc-json

Contents

• Usage
• Support
• Other Adapters
• License

Usage

spacedoc-json requires a working Spacedoc setup. Add json to your Spacedoc config like so:

Spacedoc.config({
  adapters: ['json']
});

Or in spacedoc.yml in your project root:

adapters:
  - json

In pages that require JavaScript documentation, add json to the list of docs in the page's Front Matter. The value should be a string path to the JSON value, relative to the working directory.

---
title: Spec
docs:
  json: spec/schema.json
---

Support

spacedoc-json supports these features of JSON schema:

• title
• description
• type
• properties
• required
• items

Other Adapters

• spacedoc-sass: SassDoc adapter
• spacedoc-js: JSDoc adapter

License

MIT © Geoff Kimball