https://github.com/tf/sassdoc-theme-pageflow
A fork of the default theme to customize the color scheme
https://github.com/tf/sassdoc-theme-pageflow
Last synced: over 1 year ago
JSON representation
A fork of the default theme to customize the color scheme
- Host: GitHub
- URL: https://github.com/tf/sassdoc-theme-pageflow
- Owner: tf
- License: mit
- Created: 2016-01-19T15:08:33.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-01-15T16:05:14.000Z (over 6 years ago)
- Last Synced: 2025-01-30T18:43:28.124Z (over 1 year ago)
- Language: CSS
- Size: 241 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SassDoc Default Theme
This is [SassDoc](https://github.com/SassDoc/sassdoc)'s default theme which means this is the theme that will be used when running SassDoc without a custom theme.
This theme uses [Themeleon](https://github.com/themeleon/themeleon) as a theme engine, and [themeleon-swig](https://github.com/themeleon/themeleon-swig) as a template engine, directly plugged into Themeleon.
Because this is likely to be the most used theme of all, it is not as simple as a theme can get. For instance, there is quite a bit of logic in both `index.js` and the Swig templates. Fortunately, you don't have to deal with that at all.
## Customising the view
There are some possibilites to customise the theme's view. Essentially what's being displayed, what's not, and what are the project informations to be displayed in the header and footer.
To learn how to customise the theme's view, please read [the documentation on SassDoc's site](http://sassdoc.com/customising-the-view/). Fear not! It's all about creating a configuration file. No big deal.