There are a few links you can use with different purposes.
Link type |
Markup |
Renders as |
Description |
|---|---|---|---|
External Link |
`External Link <https://docs.scylladb.com/>`_
|
Use this markup to create a link to another site or project. When rendered it has an arrow pointing out icon. It opens the content in a new tab. |
|
Internal Cross-reference |
:ref:`Internal Link <here>`
|
This is an internal cross reference. It requires a bookmark. Content opens in the same tab. |
|
Internal Cross-reference Bookmark |
.. _here:
|
This is an internal cross reference bookmark. It requires an internal cross-reference anchor (above). It does not render, but serves as a point to link to. |
|
Internal Doc Reference |
:doc:`Internal Doc <../index>`
|
This is an internal doc cross reference. it looks for a file. A full path is required. |
|
Download Link |
:download:`download <index.rst>`
|
This opens a download window. It is used to help users download software or files. |