added repository overview

Author: mkalkbrenner

.github/workflows/deploy.yml

@@ -27,6 +27,7 @@ jobs:
         run: |
           ls -R ./out  # Debug: Show built files
           test -f ./out/index.html || exit 1  # Fail if no index.html
+          grep -q "⚠️ Failed to load repository data" ./out/github_repos.html && exit 1
 
       - name: Deploy to GitHub Pages
         if: github.ref == 'refs/heads/main' && github.event_name == 'push'

.gitignore

@@ -1,3 +1,6 @@
 .vscode
 .DS_Store
-venv
+venv
+build
+data
+mkdocs_github_repos_plugin.egg-info

README.md

@@ -27,6 +27,11 @@ You can see the commits and page builds in the [Actions tab](https://github.com/
 
 You should be able to access the doc site via your web browser at `localhost:8000`.
 
+To start the server locally again later:
+
+1. `source venv/bin/activate`
+2. `mkdocs serve`
+
 ## To contribute
 
 We would love contributions to the docs! We have a [Contributing Guide](/docs/about/help_docs.md)

docs/github_repos.md

@@ -0,0 +1 @@
+<!-- This content will be replaced by the plugin -->

docs/ppuc/getting_started.md

@@ -3,6 +3,7 @@
 ## Planning
 
 If you want to run an existing playfield with PPUC you need to take some decisions:
+
 - Should the original wiring be kept?
 - Should lamps (inserts, GI and/ flashers) be replaced by addressable RGB LEDs?
 - Should switches be wired using a matrix or directly.
@@ -18,6 +19,7 @@ protocol enhances the DOF protocol which is known from the virtual pinball world
 Dependeing on your decisions abouve, you you might need different IO boards and a different amount.
 The entire hardware is open source and you can order the boards from your prefered PCB manufacturer.
 Gerber and BOM files are part of the repositories:
+
 - [IO_16_8_1](https://github.com/PPUC/Hardware_IO_16_8_1)
 - [IO_16x8_matrix](https://github.com/PPUC/Hardware_IO_16x8_matrix)
 - [Out_8X10](https://github.com/PPUC/Hardware_Out_8x10)
@@ -36,6 +38,7 @@ Repeat that procedure for every board.
 ## Wiring the boards
 
 todo:
+
 - Power
 - RS485 bus
 - Coils

docs/stylesheets/ppuc.css

@@ -60,3 +60,93 @@
 .md-content .md-typeset img, .md-content  .md-typeset svg, .md-content .md-typeset video {
   border: 1px gray solid;
 }
+
+/* GitHub Repos Grid */
+.github-repos {
+    display: grid;
+    grid-template-columns: repeat(auto-fill, minmax(300px, 1fr));
+    gap: 1.5rem;
+    margin: 1.5rem 0;
+}
+
+/* Repo Card */
+.github-repo-card {
+    border: 1px solid var(--md-default-fg-color--lightest);
+    border-radius: 0.25rem;
+    padding: 1rem;
+    transition: box-shadow 0.25s, transform 0.25s;
+    background: var(--md-default-bg-color);
+    position: relative;
+}
+
+.github-repo-card:hover {
+    box-shadow: 0 0.25rem 0.5rem rgba(0,0,0,0.1);
+    transform: translateY(-2px);
+}
+
+.github-repo-card h3 {
+    margin-top: 0;
+    margin-bottom: 0.5rem;
+}
+
+.github-repo-card h3 a {
+    color: var(--md-typeset-a-color);
+}
+
+.github-repo-card p {
+    margin-bottom: 0.75rem;
+    color: var(--md-default-fg-color--light);
+    font-size: 0.9rem;
+}
+
+/* Release Info */
+.github-repo-release {
+    margin-top: 0.75rem;
+    padding-top: 0.75rem;
+    border-top: 1px dashed var(--md-default-fg-color--lightest);
+    font-size: 0.85rem;
+}
+
+.github-repo-release a {
+    color: var(--md-accent-fg-color);
+}
+
+.release-date {
+    color: var(--md-default-fg-color--light);
+    font-size: 0.8rem;
+    display: block;
+    margin-top: 0.25rem;
+}
+
+/* Stats */
+.repo-stats {
+    display: flex;
+    gap: 1rem;
+    margin-bottom: 0.75rem;
+    font-size: 0.85rem;
+}
+
+.repo-stats span {
+    display: flex;
+    align-items: center;
+    gap: 0.25rem;
+}
+
+/* Archived Repo Indicator */
+.github-repo-card[data-archived="true"] {
+    opacity: 0.8;
+    position: relative;
+}
+
+.github-repo-card[data-archived="true"]::after {
+    content: "Archived";
+    position: absolute;
+    top: 0.5rem;
+    right: 0.5rem;
+    background: var(--md-default-fg-color--lightest);
+    color: var(--md-default-bg-color);
+    padding: 0.1rem 0.5rem;
+    border-radius: 0.25rem;
+    font-size: 0.7rem;
+    font-weight: bold;
+}

mkdocs.yml

@@ -2,13 +2,31 @@ site_name: Pinball Power-Up Controller & DMD
 site_url: https://ppuc.github.io/docs/
 site_description: Pinball Power-Up Controller & DMD (PPUC) is a free and open-source pinball controller and display system.
 use_directory_urls: true
-repo_url: https://github.com/PPUC/docs
-repo_name: Website source on GitHub
-edit_uri: blob/main/docs/
+repo_url: https://github.com/PPUC
+repo_name: PPUC on GitHub
+edit_uri: dosc/blob/main/docs/
 docs_dir: docs
 
 plugins:
   - search
+  - github_repos:
+      organization: PPUC
+      cache_minutes: 30
+      github_token: ""  # Only needed for private repos
+      exclude_repos:
+        - dmd
+        - docs
+        - .github
+        - ZeDMD_Updater
+        - ColorizingDMD
+        - pindmd3-firmware
+        - libppuclogger
+      include_archived: false  # Whether to show archived repos
+      forked_repos:
+        - dmd-extensions
+        - pinmame
+        - libdmdutil
+
 extra_css:
   - stylesheets/ppuc.css
 
@@ -65,6 +83,7 @@ extra:
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/PPUC
+      name: PPUC Organization
     - icon: fontawesome/brands/discord
       link: https://discord.gg/fkkk4MbBn5
       name: Join our Discord
@@ -84,4 +103,5 @@ nav:
     - ppuc_hardware/out_8x10.md
     - ppuc_hardware/opto_16.md
   - ZeDMD:
-    - zedmd/index.md
+    - zedmd/index.md
+  - GitHub Repositories: github_repos.md