Local¶

Requirements¶

• Python 3.13
• uv

Local installation¶

To install and locally test the Mkdocs plugin, you need to follow these steps:

pip install uv
uv venv
uv sync
uv run mkdocs serve

Quick installation tutorial¶

1. Click on use this template
2. Use the name of your choice
3. Set and edit the mkdocs.yml in the root of the repository. It is possible to use a github action: “generate.yml”, that will automatically update the mkdocs.yml.

Plugin configuration¶

🆕 Enveloppe 6.1.0 : You can load the settings from the preset using the button “Preset” and selecting mkdocs in the selector!

The majority of the settings are optional and help you to manage your repository.

The mandatory settings are :

1. In Upload configuration :
   - Folder behavior: YAML frontmatter or Obsidian Path
   - Root folder: docs
   - Folder note: index.md
   - Excluded files : (Only if you use the auto-clean up function) : docs/assets/js, docs/assets/meta, docs/assets/css, tags.md, graph.md
2. Content’s conversion :
   - Internal Links : Toggle on
3. Embed files :
   - Transfer attachments:✅
   - Default attachment folder: docs/assets/img
   The images must be in the docs/ folder, but you can change the assets/img part as you want.

Support¶

• Wiki links ([[Links]])
• File transclusion/embed, both wiki links and markdown links
• Obsidian callout and custom callouts
• Folder notes and their citations
• Custom attributes
• Sharing state and custom folder hierarchies
• Mobile and desktop compatibility
• File mini preview on hover