MkDocs Roamlinks Plugin

An MkDocs plugin that simplifies relative linking between documents and convert [[roamlinks]] for vscode-foam & obsidian

Setup

Install the plugin using pip:

pip install mkdocs-roamlinks-plugin

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - roamlinks 

Configuration

Option	Default	Description
ignore_codeblocks	true	When enabled, links inside code blocks (inline and fenced) are not converted

Example with configuration:

plugins:
  - search
  - roamlinks:
      ignore_codeblocks: true

Usage

To use this plugin, simply create a link that only contains the filename of file you wish to link to.

origin	convert
[Git Flow](git_flow.md)	[Git Flow](../software/git_flow.md)
[[Git Flow]]	[Git Flow](../software/git_flow.md)
[[software/Git Flow]]	[software/Git Flow](../software/git_flow.md)
![[image.png]]	
[[#Heading identifiers]]	[Heading identifiers in HTML](#heading-identifiers-in-html)
[[Git Flow#Heading]]	[Git Flow](../software/git_flow.md#heading)
![[image.png|Description|800x600]]	{ width="600"; height="800" }

TODO

• convert admonition, for example

obsidian style admonition

> [!info]
> something

to mkdoc material style

!!! note

    something

• %% comment %% to <!-- comment -->