Snippet¶
Snippet is a template that makes it easy to enter code patterns.
When you enter a trigger character, input suggestions will be displayed.
Triggers |
Inserted character |
|---|---|
code |
.. code-block:: LANGUAGE |
image |
.. image:: PATH |
figure |
.. figure:: PATH |
attention |
.. attention:: |
seealso |
.. seealso:: |
note |
.. note:: |
warning |
.. warning:: |
error |
.. error:: |
hint |
.. hint:: |
important |
.. important:: |
caution |
.. caution:: |
danger |
.. danger:: |
tip |
.. tip:: |
admonition |
.. admonition:: |
rubric |
.. rubric:: |
literalinclude |
.. literalinclude:: |
toctree |
.. toctree:: |
contents |
.. contents:: TITLE |
linktarget
|
`Title`_
.. _Title: http://link
|
link |
`TITLE <http://link>`_ |
label |
.. _LABEL : |
ref |
:ref:`LABEL` |
doc |
:doc:`/DOC ` |
download |
:download:`TITLE <PATH>` |
file |
:file:`PATH ` |
numref |
:numref:`TITLE <FIGURE>` |
math |
:math:`EXPRESSION ` |
command |
:command:`TITLE ` |
guilabel |
:guilabel:`TITLE ` |
key |
:kbd:`SHORTCUT ` |
menu |
:menuselection:`MENU –> MENU2` |