Markdown support | ScyllaDB Docs

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:

Install the extension:
```
poetry add myst-parser
```
Load the extension in the conf.py configuration file:
```
extensions = ["myst_parser"]
```
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?