{"repo":"GooRoo/mkdocs-obsidian-bridge","free":true,"listed":false,"github":"https://github.com/GooRoo/mkdocs-obsidian-bridge","clone":"git clone https://github.com/GooRoo/mkdocs-obsidian-bridge.git","description":"Use Obsidian’s syntax for your website with this MkDocs plugin","language":"Python","stars":84,"topics":["autolinks","markdown","mkdocs","mkdocs-plugin","obsidian","obsidian-md","roam-research"],"license":"BSD-3-Clause","category":"docs-static-sites","readme_excerpt":"[Obsidian][obsidian] ➡️ [MkDocs][mkdocs] Bridge An MkDocs plugin that helps exporting your Obsidian vault as an MkDocs site. What it does I began writing this plugin to simplify exporting my Obsidian vault to GitHub Pages using MkDocs. The plugin is still in development since there are a lot more features that could possibly be implemented, however, currently it has the following features: - Auto-expand incomplete Markdown links - Auto-expand incomplete Obsidian's internal links - Detect and mark invalid links (to style them differently) Auto-expanding incomplete links By auto-expanding I mean that you don't need to write a full path to the page you are linking to (exactly like in [Obsidian][obsidian]). Consider the following folder structure: If you are editing Sport.md , you could write: but with this plugin you can just drop the path: or even write the [Obsidian][obsidian] way: Name clashes What if you have Books.md in both 2021 and 2022? By default, the plugin tried to find the shortest relative path (again, like [Obsidian][obsidian]), e.g. is translated into: But you can also give the resolver a hint by specifying the path partially: or Both variants work equivalently. How to enable Install the plugin with: The plugin depends on some features of Python 3.10, so this is the minimum required version. Then you can enable it in your mkdocs.yml config: Embedding of media files If you want to have Obsidian-like embedding of audio and video files or even YouTube videos, enable ","default_branch":null,"files":null,"tree":[],"storefront":"/r/GooRoo","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/GooRoo/mkdocs-obsidian-bridge/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}