Browse Source

end of testing for tonight

main
IronicBadger 7 months ago
parent
commit
71706ab90e
  1. 10
      docs/Writing Tips.md
  2. 4
      mkdocs.yml
  3. 3
      requirements.txt

10
docs/Writing Tips.md

@ -1,5 +1,8 @@
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.
!!!info
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](https://git.zetdemo.ktz.me/ironicbadger/self-hosted-zettelkasten-wiki/raw/branch/main/docs/Writing%20Tips.md) 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:
@ -19,13 +22,6 @@ We can take this even further by customising the text of a link to a specific su
Before: [[Writing Tips#Backlinking to sub-headers]]
After: [[Writing Tips#Backlinking to sub-headers|Custom Text]]
```
`Before: [\[Writing Tips#Backlinking to sub-headers]\]`
```md
[[Gitea#docker-compose snippet]]
[[Gitea#docker-compose snippet|test]]
```
[[Gitea#docker-compose snippet]]

4
mkdocs.yml

@ -57,10 +57,6 @@ markdown_extensions:
- pymdownx.superfences # allows for the nesting of code blocks inside other blocks
- pymdownx.keys
plugins:
- exclude:
- "Writing Tips.md"
copyright: 2021 © Alex Kretzschmar
extra:
social:

3
requirements.txt

@ -4,5 +4,4 @@ mkdocs-material-extensions
mkdocs-minify-plugin
mkdocs-git-revision-date-plugin
pymdown-extensions
mkdocs-roamlinks-plugin
mkdocs-exclude
mkdocs-roamlinks-plugin
Loading…
Cancel
Save