#55 Add backlinks to the sidebar

docker-compose.yml

@@ -9,7 +9,7 @@ services:
       - 8999:8000
     environment:
       LIVE_RELOAD_SUPPORT: 'true'
-      ADD_MODULES: fontawesome-markdown mkdocs-git-revision-date-localized-plugin mkdocs-material==9.4.1 mkdocs-build-plantuml-plugin mkdocs-new-features-notifier mkdocs-git-authors-plugin markdown-include mkdocs-simple-hooks mkdocs-video tzdata
+      ADD_MODULES: fontawesome-markdown mkdocs-git-revision-date-localized-plugin mkdocs-material==9.4.1 mkdocs-build-plantuml-plugin mkdocs-new-features-notifier mkdocs-git-authors-plugin markdown-include mkdocs-simple-hooks mkdocs-video tzdata mkdocs-backlinks
       FAST_MODE: 'true'
       DOCS_DIRECTORY: /mkdocs
     volumes:

mkdocs.yml

@@ -70,6 +70,8 @@ plugins:
   - git-authors
   - git-revision-date-localized:
       type: datetime
+  - mkdocs-backlinks:
+      ignored_pages: [ 'Tags', 'Home' ]
   - mkdocs-simple-hooks:
       hooks:
         on_config: "docs.hooks:append_nav"

overrides/partials/toc.html

+{% set title = lang.t("toc") %}
+{% if config.mdx_configs.toc and config.mdx_configs.toc.title %}
+{% set title = config.mdx_configs.toc.title %}
+{% endif %}
+<nav class="md-nav md-nav--secondary" aria-label="{{ title }}">
+  {% set toc = page.toc %}
+  {% set first = toc | first %}
+  {% if first and first.level == 1 %}
+  {% set toc = first.children %}
+  {% endif %}
+  {% if toc %}
+  <label class="md-nav__title" for="__toc">
+    <span class="md-nav__icon md-icon"></span>
+    {{ title }}
+  </label>
+  <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+    {% for toc_item in toc %}
+    {% include "partials/toc-item.html" %}
+    {% endfor %}
+  </ul>
+  {% endif %}
+</nav>
+
+{% if backlinks %}
+<nav class="md-nav" aria-label="Backlinks">
+  <label class="md-nav__title" for="__backlinks">
+    <span class="md-nav__icon md-icon"></span>
+    Backlinks
+  </label>
+  <ul class="md-nav__list" data-md-component="backlinks" data-md-scrollfix>
+    {% for backlink in backlinks %}
+    <li class="md-nav__item">
+      <a href="/{{ backlink.url }}" class="md-nav__link">
+        {{ backlink.title }}
+      </a>
+    </li>
+    {% endfor %}
+  </ul>
+</nav>
+{% endif %}