Settings

Settings for coltrane are specified in a COLTRANE dictionary in the settings.py file. All env settings are available to be set directly. Just remove the leading “COLTRANE_” from the environment name if applicable.

# settings.py

...

# Sample `coltrane` settings
COLTRANE = {
    "MISTUNE_PLUGINS": [
        "strikethrough",
        "footnotes",
        "table",
        "task_lists",
        "def_list",
        "abbr",
        "mark",
        "insert",
        "superscript",
        "subscript",
    ],
}

...

Note

coltrane settings can be passed into the initialize() method in app.py as kwargs.

# existing app.py file
wsgi = initialize(MARKDOWN_EXTRAS=["metadata",], MISTUNE_PLUGINS=["table",])
# rest of the app.py file

Keys

The keys below are specific to the COLTRANE dictionary settings.py. But, all env settings can be used.

MISTUNE_PLUGINS

The features that should be enabled when rendering markdown with mistune. A list of all available features: https://mistune.lepture.com/en/latest/plugins.html. The default extras are:

[
    "strikethrough",
    "footnotes",
    "table",
    "task_lists",
    "def_list",
    "abbr",
    "mark",
    "insert",
    "superscript",
    "subscript",
]

VIEW_CACHE

Caches the rendered HTML when dynamically rendering. Enabled by adding the SECONDS key to a VIEW_CACHE dictionary. Not used for static sites.

SECONDS

Specifies how long the markdown should be cached when Django is dynamically serving the markdown.

COLTRANE = {
    # other settings
    "VIEW_CACHE": {"SECONDS": 60 * 15},
}

CACHE_NAME

Specifies a name for the cache to use. Defaults to “default”.

COLTRANE = {
    # other settings
    "VIEW_CACHE": {"SECONDS": 60 * 15, "CACHE_NAME": "coltrane-view-cache"},
}