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

Markdown support¶

The theme supports writing documents in Markdown thanks to the extension recommonmark.

Installation¶

See recommonmark docs.

Cheatsheet¶

For Markdown syntax reference, you can use this Cheatsheet.

Using directives in Markdown¶

Recommonmark lets you use restructuredText directives with the eval_rst code block. Here’s an example:

    ```eval_rst
    .. autoclass:: recommonmark.transform.AutoStructify
        :show-inheritance:
    ```
PREVIOUS
Multiversion options
NEXT
Redirections support
  • 1.2
    • 1.2
    • 1.1
    • 1.0
  • Getting started
    • Toolchain
    • Installation
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirections support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • 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
    • Installation
    • Cheatsheet
    • Using directives in Markdown
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 03 May 2022.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.2.1