# Links

There are a few links you can use with different purposes.

| Link type                                    | Markup                                                                                         | Renders as                                                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                    |
|----------------------------------------------|------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| External Link                                | ```rst<br/>`External Link <https://docs.scylladb.com/>`_<br/>```                               | [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                     | ```rst<br/>:ref:`Internal Link <here>`<br/>```                                                 | [Internal Link](#here)                                                                                       | This is an internal cross reference. It requires a bookmark. Content opens in the same tab.                                                                                                                                                                                                                                                                                                                    |
| Internal Cross-reference Bookmark            | ```rst<br/>.. _here:<br/>```                                                                   | <a id="here"></a>                                                                                            | 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       | ```rst<br/>:ref:`Link to a config param <confprop_parameter_name>`<br/>```                     | Renders the parameter name as a hyperlink.                                                                   | This is an internal cross-reference to a parameter on the [Configuration Parameters](https://opensource.docs.scylladb.com/stable/reference/configuration-parameters.html) page.<br/>It does NOT require a bookmark, as parameter names on that are page implicit bookmarks. Content opens in the same tab.<br/>This option only applies to the `scylladb/sylladb` and `scylladb/scylla-enterprise` projects.   |
| Internal Cross-reference to Parameter Gropus | ```rst<br/>:ref:`Link to a config param <confgroup_parameter_name>`<br/>```                    | Renders the name of the parameter group as a hyperlink.                                                      | This is an internal cross-reference to a parameter group on the [Configuration Parameters](https://opensource.docs.scylladb.com/stable/reference/configuration-parameters.html) page.<br/>It does NOT require a bookmark, as group names on that are page implicit bookmarks. Content opens in the same tab.<br/>This option only applies to the `scylladb/sylladb` and `scylladb/scylla-enterprise` projects. |
| Internal Doc Reference                       | ```rst<br/>:doc:`Internal Doc <../index>`<br/>```                                              | [Internal Doc](https://sphinx-theme.scylladb.com/stable/index.md)                                            | This is an internal doc cross reference. it looks for a file. A full path is required.                                                                                                                                                                                                                                                                                                                         |
| Download Link                                | ```rst<br/>:download:`download <index.rst>`<br/>```                                            | [`download`](https://sphinx-theme.scylladb.com/stable/_downloads/be7f6be25acd9f7165be42ec04587130/index.rst) | This opens a download window. It is used to help users download software or files.                                                                                                                                                                                                                                                                                                                             |
| Page Anchor Link                             | ```rst<br/>:page-anchor:`System requirements </examples/headings#system-requirements>`<br/>``` | [System requirements](https://sphinx-theme.scylladb.com/stable/examples/headings.md#system-requirements)     | Links to an arbitrary anchor of any page in the project, without validating the anchor.<br/>Use it for anchors that Sphinx cannot see at build time because JavaScript generates them,<br/>such as endpoint deep links on API reference pages rendered with Redoc or Swagger UI.<br/>Whenever possible, prefer built-in Sphinx roles such as `:ref:` or `:doc:`,<br/>which validate the target at build time.  |
