# mkdocs-content-tabs
<!--
[](https://github.com/sondregronas/mkdocs-callouts/commit/)
-->
[](https://pypi.org/project/mkdocs-callouts/)
This repository is modified from [mkdocs-callouts](https://github.com/sondregronas/mkdocs-callouts).
The plugin converts Obsidian tabs([obsidian-tab-panels](https://github.com/GnoxNahte/obsidian-tab-panels) or [obsidian-html-tabs](https://github.com/ptournet/obsidian-html-tabs)) into [content tabs supported by MkDocs](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#content-tabs).
## 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:
```yaml
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:
````` text
~~~ 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.
`````
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-content-tabs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "mkdocs, mkdocs-plugin, markdown, obsidian, content-tabs",
"author": null,
"author_email": "epleone <epleone@qq.com>",
"download_url": "https://files.pythonhosted.org/packages/3a/9b/e1af538222362e73f52f316eca05d6dab8a2850bf37d96850ece1d535411/mkdocs_content_tabs-1.0.5.tar.gz",
"platform": null,
"description": "# mkdocs-content-tabs\r\n<!--\r\n[](https://github.com/sondregronas/mkdocs-callouts/commit/)\r\n-->\r\n\r\n[](https://pypi.org/project/mkdocs-callouts/)\r\n\r\n\r\nThis repository is modified from [mkdocs-callouts](https://github.com/sondregronas/mkdocs-callouts).\r\n\r\n\r\nThe plugin converts Obsidian tabs([obsidian-tab-panels](https://github.com/GnoxNahte/obsidian-tab-panels) or [obsidian-html-tabs](https://github.com/ptournet/obsidian-html-tabs)) into [content tabs supported by MkDocs](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#content-tabs).\r\n\r\n\r\n\r\n## Setup\r\nInstall the plugin using pip:\r\n\r\n`pip install mkdocs-content-tabs`\r\n\r\nActivate the plugin in `mkdocs.yml`, note that some markdown_extensions are required for this plugin to function correctly:\r\n\r\n```yaml\r\nmarkdown_extensions:\r\n - nl2br\r\n - admonition\r\n - pymdownx.details\r\n - pymdownx.superfences\r\n\r\nplugins:\r\n - search\r\n - content-tabs\r\n```\r\n\r\n> **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.\r\n\r\n\r\n## Usage\r\nmkdocs-content-tabs converts the following:\r\n\r\n\r\n````` text\r\n ~~~ tabs\r\n === c++\r\n ``` cpp\r\n std::cout << \"hello, c++!\" << std::endl;\r\n ```\r\n\r\n === python\r\n ``` python\r\n print(\"hello, python!\")\r\n ```\r\n\r\n === text\r\n this is a test.\r\n ~~~\r\n`````\r\n\r\n\r\nand turns it into:\r\n`````\r\n=== \"c++\"\r\n``` cpp\r\nstd::cout << \"hello, c++!\" << std::endl;\r\n```\r\n=== \"python\"\r\n``` python\r\nprint(\"hello, python!\")\r\n```\r\n\r\n=== \"text\"\r\nthis is a test.\r\n`````\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple plugin that converts Obsidian content tabs and converts them into mkdocs supported content tabs.",
"version": "1.0.5",
"project_urls": {
"homepage": "https://github.com/epleone/mkdocs-content-tabs"
},
"split_keywords": [
"mkdocs",
" mkdocs-plugin",
" markdown",
" obsidian",
" content-tabs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6af6846c5ad5a827973df1b84b4577c6ea7848d31759d0a336cf68a6fd47b45c",
"md5": "461b9ccb20a0b0bba778a051d02c6045",
"sha256": "0378b8491eb5445d5e9ebfdd940f08dff4923ff2483ef3dd96e2a241489ecea0"
},
"downloads": -1,
"filename": "mkdocs_content_tabs-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "461b9ccb20a0b0bba778a051d02c6045",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4811,
"upload_time": "2024-12-11T10:59:44",
"upload_time_iso_8601": "2024-12-11T10:59:44.523039Z",
"url": "https://files.pythonhosted.org/packages/6a/f6/846c5ad5a827973df1b84b4577c6ea7848d31759d0a336cf68a6fd47b45c/mkdocs_content_tabs-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3a9be1af538222362e73f52f316eca05d6dab8a2850bf37d96850ece1d535411",
"md5": "0b1ba9ab17c4048266c76d138d8c00dc",
"sha256": "a3096dd5378a3f13709a2ffe1796a7d5c60b5639266a89a4dbda006e710151d5"
},
"downloads": -1,
"filename": "mkdocs_content_tabs-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "0b1ba9ab17c4048266c76d138d8c00dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4712,
"upload_time": "2024-12-11T10:59:47",
"upload_time_iso_8601": "2024-12-11T10:59:47.013698Z",
"url": "https://files.pythonhosted.org/packages/3a/9b/e1af538222362e73f52f316eca05d6dab8a2850bf37d96850ece1d535411/mkdocs_content_tabs-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 10:59:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "epleone",
"github_project": "mkdocs-content-tabs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "mkdocs",
"specs": [
[
">=",
"1"
]
]
}
],
"lcname": "mkdocs-content-tabs"
}
JSON
