simplify doc structure

bast · Nov 12, 2018 · 80869b5 · 80869b5
1 parent dd9af8c
commit 80869b5
Show file tree

Hide file tree

Showing 7 changed files with 65 additions and 69 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -34,11 +34,7 @@ You can **style your slides** to your heart's content.
    :maxdepth: 1
    :caption: Styling your slides
 
-   style/css.rst
-   style/images.rst
-   style/background.rst
-   style/customize.rst
-   style/math.rst
+   style.rst
 
 
 .. toctree::

diff --git a/doc/style.rst b/doc/style.rst
@@ -0,0 +1,64 @@
+
+
+How to use your own CSS
+=======================
+
+If you place a file in the same path as your talk, with the same name as your
+talk, and only replace the ``.md`` suffix by ``.css``. Then the rendering engine
+will use this file:
+https://github.com/bast/cicero/blob/master/cicero/templates/render.html#L11-L13
+
+In other words, if your talk is called ``mytalk.md`` and you want to customize CSS,
+place a file called ``mytalk.css`` in the same place as your ``mytalk.md``.
+
+With this you can even override CSS directives and style your slides to your
+heart's content.
+
+Example: https://github.com/bast/cicero/tree/master/demo/remark/styling
+
+
+Images
+======
+
+You can either include images the
+`Markdown way <https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#images>`_::
+
+  ![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 1")
+
+  ![alt text](path/myimage.jpg "Local image")
+
+or the HTML way::
+
+  <img src="file.jpg" style="height: 450px;"/>
+
+
+Background image
+================
+
+
+remark
+------
+
+Setting and changing the background image is nicely documented here:
+https://github.com/gnab/remark/wiki/Markdown#background-image
+
+
+How to customize everything
+===========================
+
+You want to change looks and fonts? CSS is not enough? Perhaps you need an
+external JavaScript library?
+
+You can place ``*.head.html`` and/or ``*.body.html`` alongside your ``*.md`` slides.
+In these files you can do and change almost everything:
+https://github.com/bast/cicero/blob/master/cicero/templates/render.html.
+
+To get inspired of what is in these by default and what can be changed, please
+browse https://github.com/bast/cicero/tree/master/cicero/static/engines.
+
+
+Math equations
+==============
+
+Here is an example:
+https://github.com/bast/cicero/tree/master/demo/remark/equations
diff --git a/doc/style/background.rst b/doc/style/background.rst
diff --git a/doc/style/css.rst b/doc/style/css.rst
diff --git a/doc/style/customize.rst b/doc/style/customize.rst
diff --git a/doc/style/images.rst b/doc/style/images.rst
diff --git a/doc/style/math.rst b/doc/style/math.rst