Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions Documentation/Basics/RstCheatSheet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,12 +192,24 @@ Or like this:
Escape characters
=================

If you want to use a character, which would create some special reST markup,
with its normal meaning, you must escape it with a prepended :rst:`\`.

For example surrounding text with "*" signs normally makes it show up in italics. By
escaping the special characters "*" you make the stars normal text characters:
If you want to use a character that would normally create reST markup,
you must escape it with a prepended backslash (``\``).

.. code-block:: rst

\*non-italic\*
\*not italic\*
\`not a text role\`
\_not\_a\_reference
\\literal backslash

Looks like this:

| \*not italic\*
| \`not a text role\`
| \_not\_a\_reference
| \\literal backslash

.. note::
Inside :ref:`code blocks <writing-rest-codeblocks-with-syntax-highlighting>`
and inline code (backticks), escaping is not needed — content is displayed
literally.