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 Configuration Markdown support

Markdown support¶

The docs toolchain supports writing documents in Markdown with the help of two extensions: MyST and recommonmark.

For new projects, we recommend using the MyST due to its more extensive features and robust support. However, recommonmark will still be supported for those projects which have yet to migrate.

MyST parser¶

Installation¶

To install MyST:

  1. Install the extension:

    poetry add myst-parser
    
  2. Load the extension in the conf.py configuration file:

    extensions = ["myst_parser"]
    
  3. Add the following configuration in the conf.py to enable the colon_fence extension:

    myst_enable_extensions = ["colon_fence"]
    

For more details, see the MyST documentation.

Usage¶

MyST extends the CommonMark syntax specification. For more details, see the Authoring section of the MyST documentation.

Additionally, it provides specific support for Sphinx roles and directives. For more details, see the Roles and directives section of the MyST documentation.

recommonmark parser¶

Caution

This extension is deprecated and will be removed in a future release. If you are setting up a new project, we recommend using the MyST parser instead.

See recommonmark docs for more details on how to install and use this parser.

Was this page helpful?

PREVIOUS
Multiversion options
NEXT
Redirects support
ScyllaDB Sphinx Theme
  • 1.5
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
  • 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.4 to 1.5
    • 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

On this page

  • Markdown support
    • MyST parser
      • Installation
      • Usage
    • recommonmark parser
Logo
Docs University Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 22 Sep 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.5.1