From f6eec69d0cae3b2e540a3a85c7105c134d6734b4 Mon Sep 17 00:00:00 2001 From: kwadronaut Date: Fri, 9 Feb 2018 11:17:27 +0100 Subject: add 2018 fosdem presentation --- 2018fosdem/css/theme/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 2018fosdem/css/theme/README.md (limited to '2018fosdem/css/theme/README.md') diff --git a/2018fosdem/css/theme/README.md b/2018fosdem/css/theme/README.md new file mode 100644 index 0000000..5a6c8fa --- /dev/null +++ b/2018fosdem/css/theme/README.md @@ -0,0 +1,21 @@ +## 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 a ```.scss``` file in [/css/theme/source](https://github.com/hakimel/reveal.js/blob/master/css/theme/source). It will be automatically compiled by Grunt from Sass to CSS (see the [Gruntfile](https://github.com/hakimel/reveal.js/blob/master/Gruntfile.js)) when you run `grunt css-themes`. + +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. -- cgit v1.2.3