Skip to content

Commit

Permalink
[Docs] some more FAQs
Browse files Browse the repository at this point in the history
Signed-off-by: Paul-Elliot <peada@free.fr>
  • Loading branch information
panglesd committed Mar 25, 2024
1 parent 2496ed9 commit 94ed063
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
21 changes: 21 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#supported_image_formats>`_.

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?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
..
Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/listAttributes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Slipshow API
============

.. warning::
This is mostly relevant only if you are writing HTML by hand..

.. contents:: Table of contents
:local:
Expand Down

0 comments on commit 94ed063

Please sign in to comment.