This is my attempt to build my own vision of the SassDoc theme.
When you set the --theme option of the CLI interface, or the config.theme option, the path must be compatible with the require() function.
There's two sources of configuration options, the standard set from the core of sassdoc and the additional options provided by the theme.
See SassDoc's configuration page: http://sassdoc.com/configuration/
For now, these options mimic SassDoc's default theme.
| Option | Type | Default |
|---|---|---|
display.access |
Array | ["public", "private"] |
display.alias |
Boolean | false |
display.watermark |
Boolean | true |
basePath |
String | - |
shortcutIcon |
String | - |
sort |
Array | - |
description |
String (Markdown) | - |
descriptionPath |
String (parsed as Markdown) | - |
Future options:
| Option | Type | Default |
|---|---|---|
googleAnalytics |
String | - |
trackingCode |
String | - |
privatePrefix |
Regex | ^[_-] |
See SassDoc's annotations: http://sassdoc.com/annotations/
Coming soon
| Annotation | Description | Aliases |
|---|---|---|
@groupInstall |
Package install command for groups | - |
@groupImport |
Import statement for groups | - |
See the CONTRIBUTING.md for local setup and commands.