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
Menu
ScyllaDB Docs ScyllaDB Sphinx Theme Examples Headings

HeadingsΒΆ

While Sphinx supports many layers of headings, at ScyllaDB we try to keep the hierarchy limited to 4, excluding the title. If you have the need for a H4, chances are that you need to re-arrange the content. Watch the length of your text vs the markup. It must be at least as long as the text. It can be longer, but shorter will produce an error. Also, if your markup has a line above and below both lines must be the same length.

Use the following convention for headings:

Heading

Markup

Description

Page Title

=========
Title
=========

Has an equal sign above and below the text. Use for the title of the page. It should be used only once per page

H1

Heading 1
---------

Has a dash below the text. Use for the first level heading.

H2

Heading 2
=========

Has an equal sign below the text. Use for the second level heading.

H3

Heading 3
.........

Has dots below the text. Use for a third level heading.

H4

Heading 4
^^^^^^^^^

Has carats below the text. Use for a fourth level heading. If you need more levels, re-arrange the text.

PREVIOUS
Glossary
NEXT
Hero box
ScyllaDB Sphinx Theme
  • 1.4
    • 1.4
    • 1.3
    • 1.2
    • 1.1
    • 1.0
  • Getting started
    • Toolchain
    • Installation
    • Quickstart
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirects support
    • Search support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Labels
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • Migrating from 1.3 to 1.4
    • Migrating from 1.2 to 1.3
    • Migrating from 1.1 to 1.2
    • Migrating from 1.0 to 1.1
    • Migrating from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
  • Create an issue
  • Edit this page
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 14 Mar 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.4.1