Using pymdownx.blocks.tab with pymdownx.tabbed
The new pymdownx.blocks.tab extension is meant to replace pymdownx.tabbed, they are not meant to be used together. Their output is identical making it easy to transition by simply swapping out the syntax, but using them both together can cause issues as they both generate the same output and confuse each other.
If you are switching from pymdownx.tabbed to pymdownx.blocks.tab, ensure you disable pymdownx.tabbed to avoid issues.
Tab blocks are aimed at replacing the Tabbed extension. They function identical to Tabbed in every way, even using the same classes, except 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.tab'])
A tab can be defined using the generic block syntax and the name tab. Tabs should also specify the tab title in the header. Consecutive tabs will automatically be grouped.
/// tab | Tab 1 title
Tab 1 content
///
/// tab | Tab 2 title
Tab 2 content
///
Tab 1 titleTab 2 title
Tab 1 content
Tab 2 content
If you want to have two tab containers right after each other, you specify a hard break that will force the specified tab to start a brand new tab container.
New Tab Group/// tab | Tab A title
Tab A content
///
/// tab | Tab B title
Tab B content
///
/// tab | Tab C Title
new: true
Will be part of a separate, new tab group.
///
Tab A titleTab B title
Tab A content
Tab B content
Tab C title
Will be part of a separate, new tab group.
If desired, you can specify a tab to be selected by default with the select option.
/// tab | Tab 1 title
Tab 1 content
///
/// tab | Tab 2 title
select: True
Tab 2 should be selected by default.
///
As with all block plugins, you can always add new classes IDs or other attributes via the attributes option.
/// tab | Some title
attrs: {class: class-name: id: id-name}
Some content
///
By default, tabs generate IDs for each tab using the following template __tabbed_<tab_set_number>_<tab_number>. If it is desired to implement jumping to a specific tab with more intuitive IDs, it may be preferable to generate IDs from slugs. To do so, two options are provided: slugify and separator.
Tip
Jumping to tabs via IDs may require additional JavaScript to select the targeted tabs.
If slugify is given a slug function (you can use any that ship with Pymdownx Extensions), the Tabbed extension will generate IDs from the tab titles just like headers. separator allows for the specifying of the word separator (- is the default).
If you'd like the slugs to be prefixed with the slug of the parent header, you can enable the combine_header_slug option. If you had the following example, normally the header slug would be header and the content tab would have the slug tab.
# header
/// tab | tab
content
///
With combine_header_slug enabled, the header slug would still be header, but now the content tab slug would be header-tab.
New 10.1
combine_header_slug is new in 10.1
As Tab shares the same output and functionality as the Tabbed extension, you can check out the documentation there to learn the following:
alternate_style bool Use the experimental, alternative style. slugify function A function to generate slugs from tab titles. separator string Default word separator when generating slugs. combine_header_slug bool Combine the parent header slug with the tab content slug. Per Block Options Options Type Descriptions new bool Force the current tab to start a new tab container. select bool Force the given tab to be selected in the parent tab container. attrs dictionary A dictionary that defines attributes for the outer, wrapper element. October 18, 2024
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4