https://github.com/d13/d13-sassdoc-theme
A SassDoc theme built with next.js
https://github.com/d13/d13-sassdoc-theme
documentation documentation-generator nextjs sass sassdoc theme
Last synced: about 1 month ago
JSON representation
A SassDoc theme built with next.js
- Host: GitHub
- URL: https://github.com/d13/d13-sassdoc-theme
- Owner: d13
- Created: 2022-04-08T02:00:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-29T05:31:56.000Z (about 4 years ago)
- Last Synced: 2025-01-21T11:14:55.051Z (over 1 year ago)
- Topics: documentation, documentation-generator, nextjs, sass, sassdoc, theme
- Language: JavaScript
- Homepage:
- Size: 992 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# D13 SassDoc Theme
This is my attempt to build my own vision of the [SassDoc](https://github.com/SassDoc/sassdoc) [theme](https://github.com/SassDoc/sassdoc-theme-default).
## Changing 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.
## SassDoc Configuration
There's two sources of configuration options, the standard set from the core of sassdoc and the additional options provided by the theme.
### Core Options
See SassDoc's configuration page: http://sassdoc.com/configuration/
### Theme Options
For now, these options mimic [SassDoc's default theme](http://sassdoc.com/customising-the-view/).
| 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 | `^[_-]` |
## Annotations
### Core Annotations
See SassDoc's annotations: http://sassdoc.com/annotations/
### Theme Annotations
_Coming soon_
| Annotation | Description | Aliases |
| --------------- | ---------------------------------- | ------- |
| `@groupInstall` | Package install command for groups | - |
| `@groupImport` | Import statement for groups | - |
## Customizing the Theme or Contributing
See the [CONTRIBUTING.md](./CONTRIBUTING.md) for local setup and commands.