Spacedoc-js NPM

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

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:

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

spacedoc-js supports all JSDoc types, which includes:

The plugin supports these annotations:

9 years ago