# mkdocs-obsidian-support-plugin
---
Plugin for [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) to convert semantic in documentation
from [obsidian](https://obsidian.md/) to mkdocs-material.
[](https://pypi.org/project/mkdocs-obsidian-support-plugin/)
[](https://pypi.org/project/mkdocs-obsidian-support-plugin/)
[](https://github.com/ndy2/mkdocs-obsidian-support-plugin/blob/main/LICENSE)
```text
pip install mkdocs-obsidian-support-plugin
```
## Usage
Activate the plugin in mkdocs.yml
```yaml
plugins:
- obsidian-support
```
## features
- `obsidian callout/block styled admonition` -> `mkdocs-material admonition`
- `obsidian comment` -> `html comment`
- `obsidian wikilink image` -> `mkdocs-material mdlink image` & `image with md_in_html`
- `obsidian embed pdf` -> `html embed pdf`
- `obsidian tags` -> `mkdocs-material search`
- `obsidian html-tabs` -> `mkdocs-material content tabs`
> [!note]
>
> Some features **require setup** to activate it.
> If you interested in specific feature, see the documentation.
## github-pages
> [!tip]
>
> See https://ndy2.github.io/mkdocs-obsidian-support-plugin/ for more details
### Other plugins that helps mkdocs + obsidian
- https://github.com/sondregronas/mkdocs-callouts
- https://github.com/orbikm/mkdocs-ezlinks-plugin
Raw data
{
"_id": null,
"home_page": "https://github.com/ndy2/mkdocs-obsidian-support-plugin",
"name": "mkdocs-obsidian-support-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": null,
"keywords": "mkdocs",
"author": "ndy2",
"author_email": "emrdbs12@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/03/51/9ac64d70d51e62974147220a9750f0b8a9f3e2fe0e1a348cf4af6ee7c639/mkdocs-obsidian-support-plugin-1.4.1.tar.gz",
"platform": null,
"description": "# mkdocs-obsidian-support-plugin\n---\nPlugin for [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) to convert semantic in documentation\nfrom [obsidian](https://obsidian.md/) to mkdocs-material.\n\n[](https://pypi.org/project/mkdocs-obsidian-support-plugin/)\n[](https://pypi.org/project/mkdocs-obsidian-support-plugin/)\n[](https://github.com/ndy2/mkdocs-obsidian-support-plugin/blob/main/LICENSE)\n\n```text\npip install mkdocs-obsidian-support-plugin\n```\n\n## Usage\n\nActivate the plugin in mkdocs.yml\n\n```yaml\nplugins:\n - obsidian-support\n```\n\n## features\n\n- `obsidian callout/block styled admonition` -> `mkdocs-material admonition`\n- `obsidian comment` -> `html comment`\n- `obsidian wikilink image` -> `mkdocs-material mdlink image` & `image with md_in_html`\n- `obsidian embed pdf` -> `html embed pdf`\n- `obsidian tags` -> `mkdocs-material search`\n- `obsidian html-tabs` -> `mkdocs-material content tabs`\n\n> [!note]\n>\n> Some features **require setup** to activate it.\n> If you interested in specific feature, see the documentation.\n\n## github-pages\n\n> [!tip]\n>\n> See https://ndy2.github.io/mkdocs-obsidian-support-plugin/ for more details\n\n### Other plugins that helps mkdocs + obsidian\n\n- https://github.com/sondregronas/mkdocs-callouts\n- https://github.com/orbikm/mkdocs-ezlinks-plugin\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A MkDocs plugin that supports obsidian to mkdocs convert",
"version": "1.4.1",
"project_urls": {
"Homepage": "https://github.com/ndy2/mkdocs-obsidian-support-plugin"
},
"split_keywords": [
"mkdocs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "03519ac64d70d51e62974147220a9750f0b8a9f3e2fe0e1a348cf4af6ee7c639",
"md5": "dbe0025bd718e655d433b0e3caf6f915",
"sha256": "26d9468325e7ef6f81d8e6e9ad175c0983808d9450f5cfdf3bb316b90a9f04c5"
},
"downloads": -1,
"filename": "mkdocs-obsidian-support-plugin-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "dbe0025bd718e655d433b0e3caf6f915",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 11657,
"upload_time": "2024-09-20T13:35:21",
"upload_time_iso_8601": "2024-09-20T13:35:21.772830Z",
"url": "https://files.pythonhosted.org/packages/03/51/9ac64d70d51e62974147220a9750f0b8a9f3e2fe0e1a348cf4af6ee7c639/mkdocs-obsidian-support-plugin-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-20 13:35:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ndy2",
"github_project": "mkdocs-obsidian-support-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "mkdocs",
"specs": [
[
"~=",
"1.4.2"
]
]
},
{
"name": "setuptools",
"specs": [
[
"==",
"67.3.3"
]
]
},
{
"name": "pytest",
"specs": [
[
"~=",
"8.0.1"
]
]
},
{
"name": "assertpy",
"specs": [
[
"~=",
"1.1"
]
]
},
{
"name": "overrides",
"specs": [
[
"~=",
"7.7.0"
]
]
}
],
"lcname": "mkdocs-obsidian-support-plugin"
}
JSON
