WIP: fixing readme gen and theming

krzemienski · krzemienski · commit 66d9bcb70ae4 · 2025-03-14T02:37:37.000-04:00
diff --git a/.github/convert.rb b/.github/convert.rb
@@ -145,40 +145,59 @@ def output_toc(data)
   categories = data['categories']
 
   parents, children = categories.partition { |category| category['parent'].nil? }
+  
+  # Use a nested list for the contents section
   parents.each do |parent|
     parent_id = parent['id']
     # Only include parent categories with projects or with children that have projects
     if has_projects_recursive(projects, categories, parent_id)
-      output << "- [#{parent['title']}](##{parent_id})\n"
-
-      children.sort_by { |category| category['id'] }
-        .select { |category| category['parent'] == parent_id }.each do |child|
-        child_id = child['id']
+      parent_children = children.select { |category| category['parent'] == parent_id }
+        .sort_by { |category| category['id'] }
+        .select { |category| has_projects_recursive(projects, categories, category['id']) }
+      
+      # If parent has child categories with projects, make it a list item with nested items
+      if parent_children.any?
+        output << "- **[#{parent['title']}](##{parent_id})**\n"
         
-        # Only include child categories with projects or with grandchildren that have projects
-        if has_projects_recursive(projects, categories, child_id)
-          output << "  - [#{child['title']}](##{child_id})\n"
-
-          children.sort_by { |category| category['id'] }
-            .select { |category| category['parent'] == child_id }.each do |grandchild|
-            grandchild_id = grandchild['id']
+        # Add child categories as nested list items
+        parent_children.each do |child|
+          child_id = child['id']
+          child_grandchildren = children.select { |category| category['parent'] == child_id }
+            .sort_by { |category| category['id'] }
+            .select { |category| has_projects_recursive(projects, categories, category['id']) }
+          
+          # If child has grandchildren with projects, make it a list item with nested items
+          if child_grandchildren.any?
+            output << "  - **[#{child['title']}](##{child_id})**\n"
             
-            # Only include grandchild categories with projects or with great-grandchildren that have projects
-            if has_projects_recursive(projects, categories, grandchild_id)
-              output << "    - [#{grandchild['title']}](##{grandchild_id})\n"
-
-              children.sort_by { |category| category['id'] }
-                .select { |category| category['parent'] == grandchild_id }.each do |great_grandchild|
-                great_grandchild_id = great_grandchild['id']
+            # Add grandchild categories as nested list items
+            child_grandchildren.each do |grandchild|
+              grandchild_id = grandchild['id']
+              grandchild_great_grandchildren = children.select { |category| category['parent'] == grandchild_id }
+                .sort_by { |category| category['id'] }
+                .select { |category| has_projects(projects, category['id']) }
+              
+              # If grandchild has great-grandchildren with projects, make it a list item with nested items
+              if grandchild_great_grandchildren.any?
+                output << "    - **[#{grandchild['title']}](##{grandchild_id})**\n"
                 
-                # Only include great-grandchild categories with projects
-                if has_projects(projects, great_grandchild_id)
-                  output << "      - [#{great_grandchild['title']}](##{great_grandchild_id})\n"
+                # Add great-grandchild categories as nested list items
+                grandchild_great_grandchildren.each do |great_grandchild|
+                  output << "      - [#{great_grandchild['title']}](##{great_grandchild['id']})\n"
                 end
+              else
+                # Grandchild has no children, so it's a simple list item
+                output << "    - [#{grandchild['title']}](##{grandchild_id})\n"
               end
             end
+          else
+            # Child has no grandchildren, so it's a simple list item
+            output << "  - [#{child['title']}](##{child_id})\n"
           end
         end
+      else
+        # Parent has no children, so it's a simple list item
+        output << "- [#{parent['title']}](##{parent_id})\n"
       end
     end
   end
diff --git a/.github/workflows/build-deploy.yml b/.github/workflows/build-deploy.yml
@@ -3,6 +3,8 @@ on:
   push:
     branches:
     - master
+    paths-ignore:
+      - 'README.md'  # Ignore README.md changes to prevent infinite loops
 env:
   GH_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
   PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
@@ -51,17 +53,30 @@ jobs:
       with:
         python-version: 3.9
     - uses: actions/checkout@v4
-    - name: run README.md gen
+      with:
+        token: ${{ secrets.PERSONAL_TOKEN }}
+    - name: Generate README.md from contents.json
       run: ruby .github/convert.rb
-    - name: run database.json gen
+    - name: Commit README.md back to master if it changed
+      run: |
+        git config --global user.name 'GitHub Action'
+        git config --global user.email 'action@github.com'
+        git add README.md
+        if git diff --cached --exit-code; then
+          echo "No changes to README.md"
+        else
+          git commit -m "[ci skip] Auto-update README.md from contents.json"
+          git push
+        fi
+    - name: Generate database.json
       run: node .github/upgradeDb.js
-    - name: install mkdoc build deps
+    - name: Install mkdocs build dependencies
       run: sudo apt-get update && sudo apt-get -y install lsb-release unzip python3-pip python3-dev && pip3 install mkdocs mkdocs-material pymdown-extensions mkdocs-minify-plugin json-spec
-    - name: use makefile to install all deps to ensure we have the same versions
+    - name: Install all dependencies via makefile
       run: make site_install
-    - name: use makefile to install all deps to ensure we have the same versions
+    - name: Build MkDocs site
       run: make site_build
-    - name: Deploy docs
+    - name: Deploy docs to GitHub Pages
       uses: mhausenblas/mkdocs-deploy-gh-pages@master
       with:
         GH_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -13,37 +13,6 @@ theme:
   font:
     text: 'Menlo, DejaVu Sans Mono, Consolas, Lucida Console, monospace'
     code: 'Menlo, DejaVu Sans Mono, Consolas, Lucida Console, monospace'
-  features:
-    - navigation.instant
-    - navigation.tracking
-    - navigation.top
-    - navigation.sections
-    - navigation.expand
-    - navigation.indexes
-    - toc.integrate
-    - header.autohide
-    - search.highlight
-    - content.code.copy
-  icon:
-    repo: fontawesome/brands/github
-  logo: false
-  favicon: false
-markdown_extensions:
-  - pymdownx.highlight:
-      anchor_linenums: true
-      line_spans: __span
-      pygments_lang_class: true
-  - pymdownx.inlinehilite
-  - pymdownx.snippets
-  - pymdownx.superfences
-  - admonition
-  - tables
-  - toc:
-      permalink: true
-plugins:
-  - search
-  - minify:
-      minify_html: true
 extra:
   analytics:
     provider: google
@@ -58,4 +27,4 @@ extra:
 extra_css:
     - css/extra.css
 nav:
-  - "From FFMPEG to playback, streaming video.": "index.md"
+  - "From FFMPEG to playback, streaming video.": "index.md"
