Was this page helpful?
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 Cross-reference to Parameters |
:ref:`Link to a config param <confprop_parameter_name>`
|
Renders the parameter name as a hyperlink. |
This is an internal cross-reference to a parameter on the Configuration Parameters page.
It does NOT require a bookmark, as parameter names on that are page implicit bookmarks. Content opens in the same tab.
This option only applies to the |
Internal Cross-reference to Parameter Gropus |
:ref:`Link to a config param <confgroup_parameter_name>`
|
Renders the name of the parameter group as a hyperlink. |
This is an internal cross-reference to a parameter group on the Configuration Parameters page.
It does NOT require a bookmark, as group names on that are page implicit bookmarks. Content opens in the same tab.
This option only applies to the |
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. |
Was this page helpful?