sassdoc-filter

SassDoc Filter

SassDoc data filter.

Description

This repository contains a set of filters for SassDoc Data Interface.

These filters adds some features to SassDoc by post-processing the data. These features are optional, and not needed in the core, so it's the theme responsibility to apply filters on the raw data.

Filters

Markdown

The following elements are parsed as Markdown:

• package.description
• item.description
• item.author[]
• item.throws[]
• item.todo[]
• item.returns[].description
• item.parameters[].description

Note: item is a shorthand for data[type][name], and [] in a key represents an array.

Display

Adds an item.display boolean property.

According to the configuration, the property will be true if the item matches the criteria.

Configuration (view.json)

{
  "display": {
    "access": ["public", "private"],
    "alias": false
  }
}

Group Name

Rewrite item.group property to include a configured friendly name for each group.

The @group annotation in your Scss files contains a simple slug. Then you map each slug to a friendly name in the configuration.

With the configuration below, an item.group looking like this:

{
  "group": [["hacks"]]
}

... will be rewritten like this:

{
  "group": {"hacks": "Dirty Hacks & Fixes"}
}

Configuration (view.json)

{
  "groups": {
    "slug": "Title",
    "helpers": "Helpers",
    "hacks": "Dirty Hacks & Fixes",
    "undefined": "Ungrouped"
  }
}