https://github.com/sassdoc/sassdoc-theme-blank
A blank theme to kickstart your own.
https://github.com/sassdoc/sassdoc-theme-blank
Last synced: 10 months ago
JSON representation
A blank theme to kickstart your own.
- Host: GitHub
- URL: https://github.com/sassdoc/sassdoc-theme-blank
- Owner: SassDoc
- Created: 2014-08-08T13:46:29.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2019-11-02T12:31:30.000Z (over 6 years ago)
- Last Synced: 2025-04-07T13:21:47.776Z (about 1 year ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 10
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
SassDoc Theme Boilerplate
=========================
So you want to build your own theme? You've come to the appropriate place.
This is a blank theme so you can build yours based on this one, without
too much hassle hopefully.
This theme has no CSS, no JavaScript and barely displays any information
at all. All it has is a working view that explains how you should
proceed to output content about your documented items. For more
informations about what's being passed to the view, be sure to read
[the documentation](http://sassdoc.com/data-interface/).
Note that this theme uses:
* [Themeleon](https://github.com/themeleon/themeleon) as a theming
engine (but you could do without),
* [Swig](http://paularmstrong.github.io/swig/) as a template engine,
through
[`themeleon`](https://github.com/themeleon/themeleon) (but
you could do without).
For extra informations about building your own theme, be sure to have a
look at [the documentation](http://sassdoc.com/using-your-own-theme/).
**Don't forget to `npm install` in the theme directory if you require
it with the `--theme` option. Otherwise, this is done automatically when
you require a theme via `npm`.**
> *TIP: You might want to also have a look at the SassDoc [theme generator](http://sassdoc.com/theme-generator/).
It will customize and output all the boilerplate files for you.*