reStructuredText Markup Examples

Link To Better Examples

I was setting out to write some examples to illustrate the syntax of reStructuredText mark up. When I searched for reference material I found something that I did not feel I could improve upon.

So go there for examples.

For the sake of illustration I am showing here the RST code for the links to those examples.

Inline: `Quickref <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_

Deferred: `Quickref`_

.. _`Quickref`: https://docutils.sourceforge.io/docs/user/rst/quickref.html

Inline: Quickref

Deferred: Quickref

Source level Links

When using Pelican we can also link to ".rst" source files, the compiler converts them to links to the generated ".html" files.

Note that absolute links are relative to the "content/" directory.

`Relative file link to Markdown Examples <{filename}./md-examples-en.rst>`_

`Absosulte file link to Emacs Tip <{filename}/examples/emacs-cmd-en.rst>`_

`Deferred link to Emacs Tip`_

.. _`Deferred link to Emacs Tip`: {filename}/examples/emacs-cmd-en.rst

Relative link to Markdown Examples

Absosulte link to Emacs Insert Tip

Deferred link to Emacs Tip

Published by Pierre Bernatchez in «mark up languages». Key Words: examples, how to