Skip to main content

A Python markdown extension for wrapping texts and images in a special tag for toggling

Project description

TORO Toggler Markdown Extension

Content Toggler Markdown extension for TORO Documentation.

Installation

pip install toro-mkdocs-togglers

Usage

To properly use the toggler extension use the following markdown:

||| "TabName1"
    Tab1 content.
||| "TabName2"
    Tab2 content.

The produced HTML from the markdown will be:

<div class="toro-toggler" data-names="TabName1,TabName2">
    <div data-related-divider="TabName1">
        <p>Tab1 content.</p>
    </div>
    <div data-related-divider="TabName2">
        <p>Tab2 content.</p>
    </div>
</div>

To use the toggler extension with a nested toggler use the following markdown:

||| "TabName1"
    /// "NestedTabName1"
        Nested Tab1 content.
    /// "NestedTabName2"
        Nested Tab2 content.
||| "TabName2"
    Tab2 content.

The produced HTML from the markdown will be:

<div class="toro-toggler" data-names="TabName1,TabName2">
    <div data-related-divider="TabName1">
        <div class="toro-toggler" data-names="NestedTabName1,NestedTabName2">
            <div data-related-divider="NestedTabName1">
                <p>Nested Tab1 content.</p>
            </div>
            <div data-related-divider="NestedTabName2">
                <p>Nested Tab2 content.</p>
            </div>
        </div>
    </div>
    <div data-related-divider="TabName2">
        <p>Tab2 content.</p>
    </div>
</div>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for toro-mkdocs-togglers, version 1.0.4
Filename, size File type Python version Upload date Hashes
Filename, size toro-mkdocs-togglers-1.0.4.tar.gz (3.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page