Document editing

Text formatting

The documents are written in reStructuredText, you can use:

  • *italic* for italic text
  • **bold** for bold text
  • ``code`` for code
  • The .. center:: directive to center text

Links and referencing

External

For external links, use this syntax: `link <https://google.com>`_, result: link

Internal

Use the .. _label: directive to create a label, and :doc:`link <intro#label>` to link to it, result: link

Emphasis boxes

This is the result of .. important::

This is the result of .. note::

This is the result of .. warning::

This is the result of .. success::

Slides and text

In the document, you can use the .. slide:: directive to create a new slide.

You can use the ..discover:: directive for a zone that will appear progressively.

The ..textOnly:: directive will hide the content in the slides, and the ..slideOnly:: directive will hide the content of the document.

Math

You can use embedded LaTeX \(e^{i\pi} = -1\).

Use the math directive for display math:

$$\sum_{i=1}^{n} i = \frac{n(n+1)}{2}$$

Code

The ..code-block:: language directive can be used to display code

# A simple function
def hello():
    print("Hello, world!")

Spoiler

You can hide content with the .. spoiler:: directive.

This is a spoiler!

Images

The ..image:: directive can be used to display images:

YouTube

The ..youtube:: directive can be used to embed YouTube videos: