Details

Overview

Details blocks are an alternative to using pymdownx.details and, in fact, aim to potentially replace them in the future. The output is identical pymdownx.details, but they use the new generic block syntax.

By default, the meta-plugin is registered when pymdownx.blocks is registered, but if you were customizing which meta-plugins get loaded, you can do so by doing the following:

import markdown
md = markdown.Markdown(extensions=['pymdownx.blocks.details'])

Usage

Admonitions can be specified using the generic block syntax and the name details. A summary can be specified in the header. Additionally, you can apply a specific class like with admonitions if desired.

/// details | Some summary
Some content
///

Like with Admonitions, you can specify a special class to define the type via the type option. If type is set, a class with that name will be added, and if there is no summary, the type will be used as the summary: note -> Note.

/// details | Some summary
    type: warning

Some content
///

If you wish to specify a details as open (or not collapsed), simply use the option open.

/// details | Some summary
    open: True

Some content
///

Like admonitions, you can specify and register special shortcuts for certain details types, but unlike admonitions, details does not register any default types by default.

import markdown
from pymdownx.blocks.details import Details

md = markdown.Markdown(
    extensions=['pymdownx.blocks.details'],
    extension_configs={
        'pymdownx.blocks.details": {
            'types': ['details-note', 'details-warning', 'some-custom-type']
        }
    }
)

And then you can use your defined types:

/// some-custom-type | Some summary
Some content
///

If further control is desired, you can optionally configure a custom block with a name that differs from the actual attached class. You can also configure a default title that is not derived from the attached class.

import markdown
from pymdownx.blocks.details import Details

md = markdown.Markdown(
    extensions=['pymdownx.blocks.details'],
    extension_configs={
        'pymdownx.blocks.details": {
            'types': [{'name': 'some-custom-type', 'class': 'custom', 'title': 'My Default title'}]
        }
    }
)

Now when using:

/// some-custom-type
content
///

It would be the same as using:

/// details | My Default Title
    type: custom

content
///

As with all block plugins, you can always add new classes IDs or other attributes via the attributes option.

/// details | Some title
    attrs: {class: class-name: id: id-name}

Some content
///

Global Options

Per Block Options