From bb522c6efd9a02e611014038566b15feb28da0c8 Mon Sep 17 00:00:00 2001 From: Morgan Richomme Date: Mon, 23 May 2016 14:40:54 +0200 Subject: Add framework for presentations Change-Id: I8ba24fb4b2a3a6c8d8c69f15a1fd9259aea4ab6c Signed-off-by: Morgan Richomme --- docs/com/css/theme/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100755 docs/com/css/theme/README.md (limited to 'docs/com/css/theme/README.md') diff --git a/docs/com/css/theme/README.md b/docs/com/css/theme/README.md new file mode 100755 index 000000000..753e0c0d2 --- /dev/null +++ b/docs/com/css/theme/README.md @@ -0,0 +1,23 @@ +## Dependencies + +Themes are written using Sass to keep things modular and reduce the need for repeated selectors across files. Make sure that you have the reveal.js development environment including the Grunt dependencies installed before proceding: https://github.com/hakimel/reveal.js#full-setup + +## 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) and adding it to the compilation list in the [Gruntfile](https://github.com/hakimel/reveal.js/blob/master/Gruntfile.js). + +Each theme file 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 any selectors and styles you please. + +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. + +When you are done, run `grunt css-themes` to compile the Sass file to CSS and you are ready to use your new theme. -- cgit 1.2.3-korg