diff options
author | David Banham | 2013-03-08 10:29:54 +1100 |
---|---|---|
committer | David Banham | 2013-03-08 10:29:54 +1100 |
commit | 61c229a4f969a0720085c2710f8a7cfd8a12b4a6 (patch) | |
tree | 637eeedce43c63a6aa004d566944ad791b984e7d /css/theme/README.md | |
parent | 26d5febd7f24223900aa50d24d35e610c7c8a334 (diff) | |
parent | 7081f901da553206f746c40c4a0c1b5773697cf2 (diff) |
Merge branch 'master' of https://github.com/hakimel/reveal.js
Conflicts:
README.md
index.html
js/reveal.js
package.json
plugin/speakernotes/client.js
Diffstat (limited to 'css/theme/README.md')
-rw-r--r-- | css/theme/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/css/theme/README.md b/css/theme/README.md new file mode 100644 index 0000000..f3a2a2b --- /dev/null +++ b/css/theme/README.md @@ -0,0 +1,25 @@ +## Dependencies + +Themes are written using Sass to keep things modular and reduce the need for repeated selectors across files. Find out how to install Sass here http://sass-lang.com/, once Sass is installed run the follwing command to start monitoring the source files for changes. + +``` +sass --watch css/theme/source/:css/theme --style expanded +``` + + + +## Creating a Theme + +To create your own theme, start by duplicating any ```.scss``` file in [/css/theme/source](https://github.com/hakimel/reveal.js/blob/master/css/theme/source). Each theme does four things in the following order: + +1. **Include [/css/theme/template/mixins.scss](https://github.com/hakimel/reveal.js/blob/master/css/theme/template/mixins.scss)** +Shared utility functions. + +2. **Include [/css/theme/template/settings.scss](https://github.com/hakimel/reveal.js/blob/master/css/theme/template/settings.scss)** +Declares a set of custom variables that the template file (step 4) expects. Can be overridden in step 3. + +3. **Override** +This is where you override the default theme. Either by specifying variables (see [settings.scss](https://github.com/hakimel/reveal.js/blob/master/css/theme/template/settings.scss) for reference) or by adding full selectors with hardcoded styles. + +4. **Include [/css/theme/template/theme.scss](https://github.com/hakimel/reveal.js/blob/master/css/theme/template/theme.scss)** +The template theme file which will generate final CSS output based on the currently defined variables. |