summaryrefslogtreecommitdiffstats
path: root/userContent/presentations/2016-11-30-Profitbricks/css/theme/README.md
diff options
context:
space:
mode:
authorHolger Levsen <holger@layer-acht.org>2016-11-30 21:24:36 +0100
committerHolger Levsen <holger@layer-acht.org>2016-11-30 21:24:36 +0100
commitfa33733fc6e8050631e6e09202ca92047c98697d (patch)
tree96143574df7e31d259328144114aaf3243136649 /userContent/presentations/2016-11-30-Profitbricks/css/theme/README.md
parentf794313de062993754e7274ccd5061ab0109bb3b (diff)
downloadjenkins.debian.net-fa33733fc6e8050631e6e09202ca92047c98697d.tar.xz
presenation: move to userContent/ so it becomes visible
Signed-off-by: Holger Levsen <holger@layer-acht.org>
Diffstat (limited to 'userContent/presentations/2016-11-30-Profitbricks/css/theme/README.md')
-rw-r--r--userContent/presentations/2016-11-30-Profitbricks/css/theme/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/userContent/presentations/2016-11-30-Profitbricks/css/theme/README.md b/userContent/presentations/2016-11-30-Profitbricks/css/theme/README.md
new file mode 100644
index 00000000..5a6c8fa6
--- /dev/null
+++ b/userContent/presentations/2016-11-30-Profitbricks/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.