feat: github commiters

Author: tolstenko

.github/workflows/documentation.yaml

@@ -29,8 +29,9 @@ jobs:
 
       - name: Install dependencies
         run: |
-          apt install -y doxygen gource libgs-dev
-          pip3 install jinja2 Pygments mkdocs-material mkdocs mkdocs-same-dir mkdocs-minify-plugin mkdocs-redirects mkdocs-exclude mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-git-authors-plugin mkdocs-with-pdf
+          sudo apt-get install -y doxygen gource libgs-dev
+          pip install git+https://${{ secrets.GH_SQUID_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git
+          pip install jinja2 Pygments mkdocs mkdocs-same-dir mkdocs-minify-plugin mkdocs-redirects mkdocs-exclude mkdocs-git-committers-plugin-2 mkdocs-git-revision-date-localized-plugin mkdocs-with-pdf
           npm install 
 
       - name: Configure

.github/workflows/release-pdf.yaml

@@ -31,8 +31,9 @@ jobs:
 
       - name: Install dependencies
         run: |
-          apt install -y doxygen gource libgs-dev
-          pip3 install jinja2 Pygments mkdocs-material mkdocs mkdocs-same-dir mkdocs-minify-plugin mkdocs-redirects mkdocs-exclude mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-git-authors-plugin mkdocs-with-pdf
+          sudo apt-get install -y doxygen gource libgs-dev
+          pip install git+https://${{ secrets.GH_SQUID_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git
+          pip install jinja2 Pygments mkdocs mkdocs-same-dir mkdocs-minify-plugin mkdocs-redirects mkdocs-exclude mkdocs-git-committers-plugin-2 mkdocs-git-revision-date-localized-plugin mkdocs-with-pdf
           npm install 
 
       - name: Configure

mkdocs.yml

@@ -1,8 +1,13 @@
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
+
 site_name: Awesome GameDev Resources
+site_description: Awesome GameDev Resources for learning how to make games
 site_url: https://courses.tolstenko.net
 repo_url: https://github.com/InfiniBrains/Awesome-GameDev-Resources
 repo_name: InfiniBrains/Awesome-GameDev-Resources
 
+site_author: See contributors and authors at https://github.com/InfiniBrains/Awesome-GameDev-Resources/graphs/contributors
+
 nav:
   - Home: README.md
   - Programming:
@@ -35,41 +40,51 @@ nav:
       - Promoting: portfolio/12-promoting/README.md
       - Cover Letter: portfolio/13-cover-letter/README.md
       - CV: portfolio/14-cv/README.md
-  - Dojo:
-      - dojo/README.md
-      - Full Cycle Game Dev: dojo/Full-Cycle-SDL-Development.md
+#  - Dojo:
+#      - dojo/README.md
+#      - Full Cycle Game Dev: dojo/Full-Cycle-SDL-Development.md
 #  - AI:
 #      - artificialintelligence/README.md
 
 docs_dir: .
 
 theme:
+  language: en
   name: material
   custom_dir: overrides
+#  favicon: overrides/favicon/apple-touch-icon.png
+#  logo: overrides/favicon/apple-touch-icon.png
   features:
+    - attr_list
+    - md_in_html
+    - pymdownx.superfences
     - announce.dismiss
     - content.action.edit
     - content.action.view
     - content.code.annotate
     - content.code.copy
+    - content.code.select
     # - content.tabs.link
     - content.tooltips
     # - header.autohide
     # - navigation.expand
     - navigation.footer
     - navigation.indexes
     - navigation.instant
-    - navigation.prune
-    - navigation.sections
+    - navigation.instant.prefetch
+    - navigation.prune # prune is incompatible with expand
+#    - navigation.sections
     - navigation.tabs
-    - navigation.tabs.sticky
+#    - navigation.tabs.sticky
     - navigation.top
+#    - navigation.expand
     - navigation.tracking
+    - navigation.path
     - search.highlight
     - search.share
     - search.suggest
     - toc.follow
-    # - toc.integrate
+#    - toc.integrate
   palette:
     # Palette toggle for automatic mode
     - media: "(prefers-color-scheme)"
@@ -112,11 +127,6 @@ theme:
 
 edit_uri: edit/main/
 
-site_description: >-
-  Awesome GameDev Resources
-
-site_author: https://tolstenko.net
-
 copyright: Copyright © 2023 Tolstenko and Others
 
 markdown_extensions:
@@ -159,13 +169,18 @@ markdown_extensions:
   - pymdownx.tilde
 
 plugins:
-#  - git-committers:
-#      repository: InfiniBrains/Awesome-GameDev-Resources
-#      branch: main
+  - git-committers:
+      repository: InfiniBrains/Awesome-GameDev-Resources
+      branch: main
+      enabled: true
+      docs_path: ./
+      cache_dir: /tmp/cache/awesome-gamedev-resources
 #  - git-authors
   - git-revision-date-localized:
       enable_creation_date: true
-      fallback_to_build_date: true #todo: fix git security issue on github that prevents getting the full log
+      fallback_to_build_date: true
+      locale: en
+      timezone: America/New_York
   - same-dir
   - search:
       separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
@@ -205,13 +220,20 @@ plugins:
 #      render_js: true
 #      headless_chrome_path: headless-chromium
       #output_path: any-place/document.pdf
-      enabled_if_env: ENABLE_PDF_EXPORT
+      enabled_if_env: 'CI'
       #debug_html: true
       #show_anchors: true
 #      verbose: true
 #  - optimize
 
 extra:
+  privacy:
+    enabled: true
+  consent:
+    cookies:
+      smartlook: SmartLook
+    description: >-
+      This site uses cookies to provide you with a better user experience. By using this site you consent to our use of cookies.
   generator: false
   annotate:
     json: [ .s2 ]