Updated scripts (#78)

* updated scripts

* added workflow template and updated readme

* updated note

* updated readme

* updated files

Author: shravanngoswamii

assets/scripts/DocsNav.yml

@@ -0,0 +1,48 @@
+name: Add Navbar
+
+on:
+  workflow_run:
+    workflows: ["Documentation"]  # add workflow names that generates docs in this list like `workflows: ["Docs Workflow", "Previews Workflow]`
+    types:
+      - completed
+  workflow_dispatch:  # Allows manual triggering
+
+jobs:
+  add-navbar:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout gh-pages
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+          fetch-depth: 0
+
+      - name: Download insert_navbar.sh
+        run: |
+          curl -O https://raw.githubusercontent.com/TuringLang/turinglang.github.io/main/assets/scripts/insert_navbar.sh
+          chmod +x insert_navbar.sh
+
+      - name: Update Navbar
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email github-actions[bot]@users.noreply.github.com
+         
+          # Update all HTML files in the current directory (gh-pages root)
+          ./insert_navbar.sh .
+         
+          # Remove the insert_navbar.sh file
+          rm insert_navbar.sh
+         
+          # Check if there are any changes
+          if [[ -n $(git status -s) ]]; then
+            git add .
+            git commit -m "Added navbar and removed insert_navbar.sh"
+            git push "https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" gh-pages
+          else
+            echo "No changes to commit"
+          fi

assets/scripts/README.md

@@ -5,11 +5,8 @@ This `scripts` folder contains utilities for building Turing language satellite
 
 ## How to use
 
-Add the following line after `makedocs()` function in `docs/make.jl` of each package:
+Add a new Github Actions workflow, `DocsNav.yml` in your `main` or `master` branch and update 5th line, `workflows` in `DocsNav.yml` by adding your other workflow names that are generating docs site, previews and publishing them to gh-pages branch.
 
-```julia
-# Insert navbar in each html file
-run(`sh -c "curl -s https://raw.githubusercontent.com/TuringLang/turinglang.github.io/main/assets/scripts/insert_navbar.sh | bash -s docs/build"`)
-```
+You can find `DocsNav.yml` template [here](DocsNav.yml).
 
 See https://github.com/TuringLang/AbstractMCMC.jl/pull/141 for an example. 

assets/scripts/insert_navbar.sh

@@ -1,8 +1,9 @@
 #!/bin/bash
 
-# This script inserts a top navigation bar (e.g., `navbar.html`) into Documenter.jl generated sites. 
-# The resulting output is similar to MultiDocumenter's navigation menu. The navigation menu is 
+# This script inserts a top navigation bar (e.g., `navbar.html`) into Documenter.jl generated sites.
+# The resulting output is similar to MultiDocumenter's navigation menu. The navigation menu is
 # hard-coded at the moment, which could be improved in the future. 
+# It checks all HTML files in the specified directory and its subdirectories.
 
 # URL of the navigation bar HTML file
 NAVBAR_URL="https://raw.githubusercontent.com/TuringLang/turinglang.github.io/main/assets/scripts/navbar.html"
@@ -19,15 +20,27 @@ if [ -z "$NAVBAR_HTML" ]; then
     exit 1
 fi
 
-# Process each HTML file in the directory
-for file in $(find $HTML_DIR -name "*.html"); do
+# Process each HTML file in the directory and its subdirectories
+find "$HTML_DIR" -name "*.html" | while read file; do
+    # Remove the existing navbar HTML section if present
+    if grep -q "<!-- NAVBAR START -->" "$file"; then
+        awk '/<!-- NAVBAR START -->/{flag=1;next}/<!-- NAVBAR END -->/{flag=0;next}!flag' "$file" > temp && mv temp "$file"
+        echo "Removed existing navbar from $file"
+    fi
+
     # Read the contents of the HTML file
     file_contents=$(cat "$file")
 
     # Insert the navbar HTML after the <body> tag
-    updated_contents="${file_contents/$'<body>'/$'<body>\n'$NAVBAR_HTML}"
+    updated_contents="${file_contents/<body>/<body>
+$NAVBAR_HTML
+}"
 
     # Write the updated contents back to the file
     echo "$updated_contents" > "$file"
-    echo "Updated $file"
+
+    # Remove trailing blank lines immediately after the navbar
+    awk 'BEGIN {RS=""; ORS="\n\n"} {gsub(/\n+$/, ""); print}' "$file" > temp_cleaned && mv temp_cleaned "$file"
+
+    echo "Inserted new navbar into $file"
 done

assets/scripts/navbar.html

@@ -1,3 +1,4 @@
+<!-- NAVBAR START -->
 <style>
     html {
         scroll-padding-top: calc(55px + 1rem);
@@ -459,3 +460,4 @@
         setAppropriateHeight();
     });
 </script>
+<!-- NAVBAR END -->