spacedoc-js

SassDoc adapter for Spacedoc

Parses data from JavaScript files documented with JSDoc. For use with Spacedoc, a documentation generator.

npm install spacedoc-js

Contents

• Usage
• Support
• Other Adapters
• License

Usage

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

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

Or in spacedoc.yml in your project root:

adapters:
  - js

In pages that require JavaScript documentation, add js to the list of docs in the page's Front Matter. The value of js can be:

• A single file
• A glob of files
• An array with either of those things

---
title: Modal
docs:
  js: js/modal.js
---

Support

spacedoc-js supports all JSDoc types, which includes:

• class
• constant
• event
• function
• module
• namespace
• typedef

The plugin supports these annotations:

• @access
• @deprecated
• @parameter
• @return
• @since
• @throw
• @todo
• @type

Other Adapters

• spacedoc-sass: SassDoc adapter

License

MIT © Geoff Kimball