ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
ScyllaDB Docs ScyllaDB Sphinx Theme Examples

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. 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:

Components
  • Admonitions

  • Collapse

  • Code blocks

  • Glossary

  • Headings

  • Hero box

  • Icons

  • Images

  • Includes

  • Labels

  • Links

  • Lists

  • Mascots

  • Panel box

  • Substitutions

  • Tables

  • Tabs

  • Text

  • Toc

  • Topic box

  • Versions

Was this page helpful?

PREVIOUS
Pull requests previews
NEXT
Admonitions
ScyllaDB Sphinx Theme
  • Getting started
    • Toolchain
    • Installation
    • Quickstart
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirects support
    • Search support
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Icons
    • Images
    • Includes
    • Labels
    • Links
    • Lists
    • Mascots
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Tooltips
    • Topic box
    • Versions
  • Upgrade guides
    • Upgrading from 1.7 to 1.8
    • Upgrading from 1.6 to 1.7
    • Upgrading from 1.5 to 1.6
    • Upgrading from 1.4 to 1.5
    • Upgrading from 1.3 to 1.4
    • Upgrading from 1.2 to 1.3
    • Upgrading from 1.1 to 1.2
    • Upgrading from 1.0 to 1.1
    • Upgrading from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
  • Create an issue
  • Edit this page
Docs University Contact Us About Us
© 2024, ScyllaDB. All rights reserved.
Last updated on 08 Oct 2024.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.1