https://github.com/ndy2/mkdocs-obsidian-support-plugin

A MkDocs plugin that supports obsidian to mkdocs convert
https://github.com/ndy2/mkdocs-obsidian-support-plugin

mkdocs mkdocs-macros-plugin obsidian

Last synced: 8 months ago
JSON representation

A MkDocs plugin that supports obsidian to mkdocs convert

• Host: GitHub
• URL: https://github.com/ndy2/mkdocs-obsidian-support-plugin
• Owner: ndy2
• License: mit
• Created: 2023-02-20T02:37:40.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-20T13:47:47.000Z (almost 2 years ago)
• Last Synced: 2025-01-31T06:51:14.596Z (over 1 year ago)
• Topics: mkdocs, mkdocs-macros-plugin, obsidian
• Language: Python
• Homepage: https://ndy2.github.io/mkdocs-obsidian-support-plugin/
• Size: 1.62 MB
• Stars: 17
• Watchers: 1
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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.

[![\PyPI](https://img.shields.io/pypi/v/mkdocs-obsidian-support-plugin)](https://pypi.org/project/mkdocs-obsidian-support-plugin/)

[![\PyPi Downloads](https://img.shields.io/pypi/dm/mkdocs-obsidian-support-plugin.svg)](https://pypi.org/project/mkdocs-obsidian-support-plugin/)

[![\GitHub](https://img.shields.io/github/license/ndy2/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