A MkDocs plugin that supports obsidian to mkdocs convert
Project description
mkdocs-obsidian-support-plugin
Plugin for mkdocs-material to convert semantic in documentation from obsidian to mkdocs-material.
pip install mkdocs-obsidian-support-plugin
Usage
Activate the plugin in mkdocs.yml
plugins:
- obsidian-support
By default obsidian tags
are just shown as bold text. Obsidian style can be activated by using the following css file, that has to be activated inside the mkdocs.yml.
.hash {
background-color: #f3eefd;
border-radius: 20px;
padding: 5px;
font-weight: normal;
}
Activating this inside the mkdocs.yml
extra_css:
- assets/css/obsidian_tags.css
By using the following javascript, the search menu will be opened by clicking the tags.
$('.hash').each(function() {
var link = $(this).html();
$(this).contents().wrap('<a href="?q='+link+'">#</a>');
});
This have to be activated inside the mkdocs.yml.
extra_javascript:
- https://code.jquery.com/jquery-3.7.1.min.js
- assets/javascript/obsidian_tags.js
features
obsidian callout
->mkdocs-material admonition
obsidian wikilink image
->mkdocs-material mdlink image
&image with md_in_html
obsidian tags
->mkdocs-material search
github-pages
[!info]
See https://ndy2.github.io/mkdocs-obsidian-support-plugin/ for more details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for mkdocs-obsidian-support-plugin-0.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5733b641320466c38cbc381e9987c4d9e5cb71e73aebbbd869e0bddbbd6904d3 |
|
MD5 | b4a329c1fa09ec4b793c21610d859779 |
|
BLAKE2b-256 | 5dddd59375fd7a6de88b46f4adf0208068e6d01b2b61c40db227177c0c448894 |