Skip to content

An MkDocs plugin that automagically generates relative links between markdown pages

License

Notifications You must be signed in to change notification settings

max-uho/mkdocs-roamlinks-plugin

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This fork allows for aliases also preceded by "\|" rather than only by "|"

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 

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)
![[image.png]] ![image.png](../image/imag.png)
[[#Heading identifiers]] [Heading identifiers in HTML](#heading-identifiers-in-html)
[[Git Flow#Heading]] [Git Flow](../software/git_flow.md#heading)

About

An MkDocs plugin that automagically generates relative links between markdown pages

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 98.7%
  • Shell 1.3%