diff --git a/docs/faq.rst b/docs/faq.rst index 6a5b8f6..7121de3 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -18,6 +18,27 @@ The compiled file is a standalone html file! Just send that, no dependencies. That is, unless you've made some special things, such as including a video. In this case, put all dependencies in an archive. +How can I insert an image in my presentation? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Use the markdown syntax! ``![alternative text](path_to_file)``. The supported image types are those `supported on the web `_. + +If using a local image does not work (as in the online sliphub editor), a workaround when available is to use a link to the image on the web. + +How can I add math to my presentation? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Use the markdown syntax! +To add inline formulas, use ``$`` as in Latex. To add "display" mathematics, use a block block with math language. Here is an example: + +.. code-block:: markdown + + let $m$ be the mass, $E$ be the energy and $c$ be the light celerity. The we have: + + ```math + E = mc^2 + ``` + Is there a Markdown syntax for slipshow? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. diff --git a/docs/index.rst b/docs/index.rst index 82599a9..38c1736 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,7 +34,8 @@ We advise you to start by reading the :ref:`tutorial`. You can also peek at the tutorial syntax themes - listAttributes + .. + listAttributes faq examples diff --git a/docs/listAttributes.rst b/docs/listAttributes.rst index 5033920..f0b6363 100644 --- a/docs/listAttributes.rst +++ b/docs/listAttributes.rst @@ -3,6 +3,8 @@ Slipshow API ============ +.. warning:: + This is mostly relevant only if you are writing HTML by hand.. .. contents:: Table of contents :local: