From 29afec9346aa9f8ed2f86fe3afab16153c0b0fe2 Mon Sep 17 00:00:00 2001
From: std3 <67806187+standard3@users.noreply.github.com>
Date: Tue, 23 Apr 2024 21:20:12 +0200
Subject: [PATCH] docs: customized mkdocs

---
 .github/workflows/mkdocs.yml |  2 +-
 mkdocs.yml                   | 21 +++++++++++++++++++++
 requirements.txt             |  2 ++
 3 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
index c41d0cb..ce91ff7 100644
--- a/.github/workflows/mkdocs.yml
+++ b/.github/workflows/mkdocs.yml
@@ -11,5 +11,5 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: 3.11
-      - run: pip install mkdocs mkdocs-material mkdocstrings[python]
+      - run: pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
       - run: mkdocs gh-deploy --force --clean --verbose
diff --git a/mkdocs.yml b/mkdocs.yml
index 5f54aba..d905c29 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -5,11 +5,32 @@ site_description: Documentation for MMUShell
 repo_name: Memoscopy/mmushell
 repo_url: https://github.com/Memoscopy/mmushell
 
+edit_uri: edit/main/docs/
+
 theme:
   name: material
+  features:
+    - search.suggest
+    - search.highlight
+    - search.share
+    - content.action.edit
+    - navigation.instant
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.sections
+    - navigation.path
+    - navigation.top
+  icon:
+    repo: fontawesome/brands/github
 
 plugins:
   - mkdocstrings
+  - search
+  - git-revision-date-localized:
+      enable_creation_date: true
+  - git-committers:
+      repository: Memoscopy/mmushell
+      branch: main
 
 markdown_extensions:
   - admonition
diff --git a/requirements.txt b/requirements.txt
index 0121208..d1b1c18 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -20,4 +20,6 @@ pyelftools
 # documentation
 mkdocs
 mkdocs-material
+mkdocs-git-revision-date-localized-plugin
+mkdocs-git-committers-plugin-2
 mkdocstrings[python]