docs: customized mkdocs

.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

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

requirements.txt

@@ -20,4 +20,6 @@ pyelftools
 # documentation
 mkdocs
 mkdocs-material
+mkdocs-git-revision-date-localized-plugin
+mkdocs-git-committers-plugin-2
 mkdocstrings[python]