docs(mkdocs): Added magiclink and necessary macros to generate gitlab links.

Uses hacky approach to monkeypatch magiclink to support hosted gitlab instances.

docs/macros.py

+"""
+Hack to get the hosted gitlab magiclink extension to work with mkdocs.
+
+See: https://github.com/facelessuser/pymdown-extensions/issues/933
+"""
+import pymdownx.magiclink
+base_url = "https://gitlab.jyu.fi"
+pymdownx.magiclink.PROVIDER_INFO["gitlab"].update({
+    "url": base_url,
+    "issue": "%s/{}/{}/issues/{}" % base_url,
+    "pull": "%s/{}/{}/merge_requests/{}" % base_url,
+    "commit": "%s/{}/{}/commit/{}" % base_url,
+    "compare": "%s/{}/{}/compare/{}...{}" % base_url,
+})
+
+def define_env(env):
+    pass

docs/mkdocs.yml

@@ -51,12 +51,22 @@ markdown_extensions:
   - pymdownx.emoji:
       emoji_index: !!python/name:materialx.emoji.twemoji
       emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.magiclink:
+      user: startuplab/courses/tjts5901-continuous-software-engineering
+      repo: TJTS5901-K23_template
+      provider: gitlab
+
+      repo_url_shortener: true
+      repo_url_shorthand: true
+
 plugins:
   - offline
   - search
   - git-revision-date-localized:
       type: date
       fallback_to_build_date: true
+  - macros:
+      module_name: macros
 
 extra:
   social:

pyproject.toml

@@ -34,6 +34,7 @@ docs = [
   "mkdocs",
   "mkdocs-material",
   "mkdocs-git-revision-date-localized-plugin",
+  "mkdocs-macros-plugin",
 ]
 
 [build-system]