Spacedoc-sass NPM

spacedoc-sass

SassDoc adapter for Spacedoc

Parses data from .scss files documented with SassDoc. For use with Spacedoc, a documentation generator.

npm install spacedoc-sass

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

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

Or in spacedoc.yml in your project root:

adapters:
  - sass

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

---
title: Button
docs:
  sass: scss/components/\_button.scss
---

spacedoc-sass supports all SassDoc types, which includes:

The plugin supports these annotations:

7 years ago

8 years ago