updated & for custom navbar

Author: shravanngoswamii

assets/scripts/DocsNav.yml

@@ -27,9 +27,12 @@ jobs:
         run: |
           git config user.name github-actions[bot]
           git config user.email github-actions[bot]@users.noreply.github.com
+
+          # Define the URL of the navbar to be used
+          NAVBAR_URL="https://raw.githubusercontent.com/TuringLang/turinglang.github.io/main/assets/scripts/navbar.html"
          
           # Update all HTML files in the current directory (gh-pages root)
-          ./insert_navbar.sh .
+          ./insert_navbar.sh . $NAVBAR_URL
          
           # Remove the insert_navbar.sh file
           rm insert_navbar.sh

assets/scripts/README.md

@@ -7,6 +7,6 @@ This `scripts` folder contains utilities for building Turing language satellite
 
 Add a new Github Actions workflow, `DocsNav.yml`, in your `main` or `master` branch.
 
-You can find `DocsNav.yml` template [here](DocsNav.yml).
+You can find `DocsNav.yml` template [here](DocsNav.yml), Update the NAVBAR URL in case you want to use another navigation bar and make sure NAVBAR START AND NAVBAR END comments are there in your new navigation bar.
 
 See [AbstractMCMC.jl](https://github.com/TuringLang/AbstractMCMC.jl/blob/master/.github/workflows/DocsNav.yml) for an example. 

assets/scripts/insert_navbar.sh

@@ -1,16 +1,22 @@
 #!/bin/bash
 
-# This script inserts a top navigation bar (e.g., `navbar.html`) into Documenter.jl generated sites.
+# This script inserts a top navigation bar 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"
+# Check if the correct number of arguments are provided
+if [ "$#" -ne 2 ]; then
+    echo "Usage: $0 <html-directory> <navbar-url>"
+    exit 1
+fi
 
 # Directory containing HTML files (passed as the first argument to the script)
 HTML_DIR=$1
 
+# URL of the navigation bar HTML file (passed as the second argument to the script)
+NAVBAR_URL=$2
+
 # Download the navigation bar HTML content
 NAVBAR_HTML=$(curl -s $NAVBAR_URL)