Examples
========

This documentation covers the markup convention used for ScyllaDB Docs.

Our official documentation is written in restructuredText.
If you are not familiar with restructuredText, refer to `this cheat sheet <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_.
Keep in mind, that in this cheat sheet there may be directives or elements of the markup we're not using.

In general, there are main components to the markup of any document:

.. toctree::
   :maxdepth: 2
   :hidden:

   admonitions
   alerts
   api-documentation/index
   collapse
   code-blocks
   diagrams
   grid
   glossary
   headings
   hero-box
   icons
   images
   includes
   labels
   links
   lists
   mascots
   panel-box
   substitutions
   tables
   tabs
   text
   toc
   tooltips
   topic-box
   versions
   videos

.. panel-box::
  :title: Components
  :id: "components"
  :class: my-panel

  * :doc:`Admonitions <admonitions>`
  * :doc:`Alerts <alerts>`
  * :doc:`API Documentation <api-documentation/index>`
  * :doc:`Collapse <collapse>`
  * :doc:`Code blocks <code-blocks>`
  * :doc:`Diagrams <diagrams>`
  * :doc:`Grid <grid>`
  * :doc:`Glossary <glossary>`
  * :doc:`Headings <headings>`
  * :doc:`Hero box <hero-box>`
  * :doc:`Icons <icons>`
  * :doc:`Images <images>`
  * :doc:`Includes <includes>`
  * :doc:`Labels <labels>`
  * :doc:`Links <links>`
  * :doc:`Lists <lists>`
  * :doc:`Mascots <mascots>`
  * :doc:`Panel box <panel-box>`
  * :doc:`Substitutions <substitutions>`
  * :doc:`Tables <tables>`
  * :doc:`Tabs <tabs>`
  * :doc:`Text <text>`
  * :doc:`Toc <toc>`
  * :doc:`Topic box <topic-box>`
  * :doc:`Versions <versions>`
  * :doc:`Videos <videos>`