Skip to content

Python-Markdown

= ("[Website](" + this.website + ")") | = ("[Source](" + this.source + ")") | = ("[Documentation](" + this.docs + ")")
= ("> " + this.desc-short)

Specifications🔗

=this.title uses

  • 4 spaces of indentation
  • requires empty lines before lists and around fenced code blocks

Extensions🔗

public/tech/documentation/MkDocs

Extensions🔗

Documentation MagicLink

This plugin allows to have URLs to GitHub, GitLab, … repos and more shortened to the common shorthand you find on these services. Especially for GitLab, it will use the handy codes @<user>, #<issue number>, !<merge request>, etc. Reversely, it should be possible to use shorthands in pages and have them be linked to the configured provider and repo.

Configure custom repository host for shortening references to custom host, e.g. self-hosted GitLab server

mkdocs.yml

1
2
3
4
5
6
7
8
markdown_extensions:

  - pymdownx.magiclink:
      custom:
          myserver:
              host: "https://mydomain.com"
              label: mystuff
              type: gitlab

Took me a bit to understand this is the way to enter the config in the MkDocs config. However, it doesn’t seem to work all that well

  • links aren’t shortened
  • only @<provider>:<username> works with expicitely giving the provider name one chose (e.g. myserver) - would be nice to make this default

I started having a look into the code, maybe that will tell me why things aren’t working well or how to contribute fixes.