Skip to content

updated and optimized insert_navbar.sh #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 22, 2024
Merged

updated and optimized insert_navbar.sh #112

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c5dafd
updated and optimized insert_navbar.sh
shravanngoswamii Dec 21, 2024
c11b23b
Update insert_navbar.sh
shravanngoswamii Dec 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 31 additions & 24 deletions assets/scripts/insert_navbar.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#!/bin/bash
# This script inserts a top navigation bar 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.
# It checks all HTML files in the specified directory and its subdirectories.
# It checks all HTML files in the specified directory and its subdirectories,
# removes any existing navbar, then inserts the new navbar right after <body>.

# Function to print usage
print_usage() {
Expand All @@ -15,15 +16,17 @@ if [ "$#" -lt 2 ]; then
exit 1
fi

# Directory containing HTML files (passed as the first argument to the script)
# Directory containing HTML files
HTML_DIR=$1
# URL of the navigation bar HTML file (passed as the second argument to the script)
# URL of the navigation bar HTML file
NAVBAR_URL=$2
# Shift off the first two arguments so we can parse the rest
shift 2

# Initialize exclude list
EXCLUDE_LIST=""

# Parse optional arguments
shift 2
while [[ $# -gt 0 ]]; do
key="$1"
case $key in
Expand All @@ -39,12 +42,16 @@ while [[ $# -gt 0 ]]; do
esac
done

# Download the navigation bar HTML content
NAVBAR_HTML=$(curl -s $NAVBAR_URL)
# Determine if NAVBAR_SOURCE is a URL (starts with http or https) or a file path
if [[ $NAVBAR_SOURCE == http* ]]; then
NAVBAR_HTML=$(curl -s "$NAVBAR_SOURCE")
else
NAVBAR_HTML=$(cat "$NAVBAR_SOURCE")
fi

# Check if the download was successful
if [ -z "$NAVBAR_HTML" ]; then
echo "Failed to download navbar HTML"
echo "Failed to download navbar HTML from '$NAVBAR_URL'"
exit 1
fi

Expand All @@ -60,32 +67,32 @@ should_exclude() {
return 1 # Should not exclude
}

# Process each HTML file in the directory and its subdirectories
find "$HTML_DIR" -name "*.html" | while read file; do
# Find and process each HTML file
find "$HTML_DIR" -type f -name "*.html" | while read -r file; do
# Check if the file should be excluded
if [ ! -z "$EXCLUDE_LIST" ] && should_exclude "$file"; then
if [ -n "$EXCLUDE_LIST" ] && should_exclude "$file"; then
echo "Skipping excluded file: $file"
continue
fi

# Remove the existing navbar HTML section if present
# Remove existing navbar (if any) between <!-- NAVBAR START --> and <!-- NAVBAR END -->
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 new navbar right after the first <body> tag using awk
awk -v nav="$NAVBAR_HTML" '
/<body>/ {
print $0
print nav
next
}
{ print }
' "$file" > temp && mv temp "$file"

# Insert the navbar HTML after the <body> tag
updated_contents="${file_contents/<body>/<body>
$NAVBAR_HTML
}"

# Write the updated contents back to the file
echo "$updated_contents" > "$file"

# Remove trailing blank lines immediately after the navbar
# Remove excessive trailing blank lines after insertion
awk 'BEGIN {RS=""; ORS="\n\n"} {gsub(/\n+$/, ""); print}' "$file" > temp_cleaned && mv temp_cleaned "$file"

echo "Inserted new navbar into $file"
done
done
Loading