Writing Tips
Backlinking is a crucial part of why this solution work so well. mkdocs uses a plugin called roamlinks
to take care of turning [[backlinks]]
into real links.
Caution
Page is a work in progress due to some weirdness with escaping. Take a look at the git repo in plain text for this page to get a better understanding for now.
Customising the text of a link¶
Let's say the name of your note does not make sense in the context of sentence into which the backlink has been placed, what then? We can customise the text of a link like so:
Before: [Writing Tips](./Writing Tips.md)
After: [Custom Text](./Writing Tips.md)
That would create a link to this note with the text "Custom Text" in the mkdocs rendered output and Obsidian preview pane.
Backlinking to sub-headers¶
We can take this even further by customising the text of a link to a specific sub-heading within a back-linked page as well. Like so:
Before: [Writing Tips#Backlinking to sub-headers](./Writing Tips.md#backlinking-to-sub-headers)
After: [Custom Text](./Writing Tips.md#backlinking-to-sub-headers)
This would create a link to a sub-heading within this note and display the text "Custom Text" in the mkdocs rendered output and Obsidian preview pane.