Skip to main content

A simple plugin that converts Obsidian content tabs and converts them into mkdocs supported content tabs.

Project description

mkdocs-content-tabs

PyPi MIT license

This repository is modified from mkdocs-callouts.

The plugin converts Obsidian tabs(obsidian-tab-panels or obsidian-html-tabs) into content tabs supported by MkDocs.

Setup

Install the plugin using pip:

pip install mkdocs-content-tabs

Activate the plugin in mkdocs.yml, note that some markdown_extensions are required for this plugin to function correctly:

markdown_extensions:
  - nl2br
  - admonition
  - pymdownx.details
  - pymdownx.superfences

plugins:
  - search
  - content-tabs

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.

Usage

mkdocs-content-tabs converts the following:

  ~~~ tabs
    === c++
    ``` cpp
    std::cout << "hello, c++!" << std::endl;
    ```

    === python
    ``` python
    print("hello, python!")
    ```

    === text
    this is a test.
  ~~~

and turns it into:

=== "c++"
``` cpp
std::cout << "hello, c++!" << std::endl;
```
=== "python"
``` python
print("hello, python!")
```

=== "text"
this is a test.

Project details


Download files

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

Source Distribution

mkdocs_content_tabs-1.0.5.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_content_tabs-1.0.5-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_content_tabs-1.0.5.tar.gz.

File metadata

  • Download URL: mkdocs_content_tabs-1.0.5.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.16

File hashes

Hashes for mkdocs_content_tabs-1.0.5.tar.gz
Algorithm Hash digest
SHA256 a3096dd5378a3f13709a2ffe1796a7d5c60b5639266a89a4dbda006e710151d5
MD5 0b1ba9ab17c4048266c76d138d8c00dc
BLAKE2b-256 3a9be1af538222362e73f52f316eca05d6dab8a2850bf37d96850ece1d535411

See more details on using hashes here.

File details

Details for the file mkdocs_content_tabs-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_content_tabs-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0378b8491eb5445d5e9ebfdd940f08dff4923ff2483ef3dd96e2a241489ecea0
MD5 461b9ccb20a0b0bba778a051d02c6045
BLAKE2b-256 6af6846c5ad5a827973df1b84b4577c6ea7848d31759d0a336cf68a6fd47b45c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page