https://github.com/jonasdoesthings/mkdocs-obsidian-hooks

Hooks to add compatibility between ObsidianMD markdown files and MKDocs
https://github.com/jonasdoesthings/mkdocs-obsidian-hooks

mkdocs mkdocs-material mkdocs-plugin mkdocs-site obsidian obsidian-md obsidian-publish

Last synced: 16 days ago
JSON representation

Hooks to add compatibility between ObsidianMD markdown files and MKDocs

• Host: GitHub
• URL: https://github.com/jonasdoesthings/mkdocs-obsidian-hooks
• Owner: JonasDoesThings
• License: mit
• Created: 2023-01-15T15:19:20.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-15T15:31:16.000Z (about 2 years ago)
• Last Synced: 2024-11-20T21:53:59.112Z (3 months ago)
• Topics: mkdocs, mkdocs-material, mkdocs-plugin, mkdocs-site, obsidian, obsidian-md, obsidian-publish
• Language: Python
• Homepage:
• Size: 1.95 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# mkdocs obsidian hooks

A collection of useful mkdocs hooks that improve compatibility between Obsidian.md and mkdocs.

---

## Installation

Add the following to your `mkdocs.yml` configuration:

```yaml

hooks:

  - PATH_TO_YOUR_HOOK/HOOK_NAME.py

```

The path is relative to the `mkdocs.yml` config file location. For more information see the official mkdocs docs: https://www.mkdocs.org/user-guide/configuration/#hooks

---

## Hooks

### strip_obsidian_comments.py

**Description:** This hook strips out comments in the ObsidianMD comment format (%%  %%)

**Examples:**

```markdown

%% this inline comment will be removed from your mkdocs output %%

%% multi

line comments

also get __removed__%%

%%this

*gets removed*

%%

**this here will stay in, since it's no comment**

```

---

## License

This project is licensed under the Open Source MIT License. For the full license text, see [LICENSE.md](./LICENSE.md)