mirror of
https://github.com/awalsh128/cache-apt-pkgs-action.git
synced 2025-09-08 11:06:48 +00:00
07366a6d1e
- Refactored README.md - Added workflows for version export and management. - Removed src directory, following Go best practices - Added COMMANDS.md documentation Saving the AI semi-slop for now with broken states to get a snapshot. Too lazy to setup another chained repo.
90 lines
2.6 KiB
Bash
Executable file
90 lines
2.6 KiB
Bash
Executable file
#!/bin/bash
|
|
|
|
#==============================================================================
|
|
# update_md_tocs.sh
|
|
#==============================================================================
|
|
#
|
|
# DESCRIPTION:
|
|
# Automatically updates table of contents in all markdown files that contain
|
|
# doctoc markers. The script handles installation of doctoc if not present
|
|
# and applies consistent formatting across all markdown files.
|
|
#
|
|
# USAGE:
|
|
# ./scripts/update_md_tocs.sh
|
|
#
|
|
# FEATURES:
|
|
# - Auto-detects markdown files with doctoc markers
|
|
# - Installs doctoc if not present (requires npm)
|
|
# - Applies consistent settings across all files:
|
|
# * Excludes document title
|
|
# * Includes headers up to level 4
|
|
# * Uses GitHub-compatible links
|
|
# - Provides clear progress and error feedback
|
|
#
|
|
# TO ADD TOC TO A NEW FILE:
|
|
# Add these markers to your markdown:
|
|
# <!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
|
# <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
# <!-- doctoc --maxlevel 4 --no-title --notitle --github -->
|
|
#
|
|
# <!-- END doctoc -->
|
|
#
|
|
# DEPENDENCIES:
|
|
# - npm (for doctoc installation if needed)
|
|
# - doctoc (will be installed if missing)
|
|
#
|
|
# EXIT CODES:
|
|
# 0 - Success
|
|
# 1 - Missing dependencies or installation failure
|
|
#
|
|
# AUTHOR:
|
|
# Claude - 2025-08-28
|
|
#
|
|
# NOTES:
|
|
# - Only processes files containing doctoc markers
|
|
# - Preserves existing markdown content
|
|
# - Safe to run multiple times
|
|
#==============================================================================
|
|
|
|
# Function to check if a command exists
|
|
command_exists() {
|
|
command -v "$1" >/dev/null 2>&1
|
|
}
|
|
|
|
# Function to check if npm package is installed globally
|
|
npm_package_installed() {
|
|
npm list -g "$1" >/dev/null 2>&1
|
|
}
|
|
|
|
# Install doctoc if not present
|
|
if ! command_exists doctoc; then
|
|
echo "doctoc not found. Installing..."
|
|
if ! command_exists npm; then
|
|
echo "Error: npm is required to install doctoc"
|
|
exit 1
|
|
fi
|
|
|
|
if ! npm_package_installed doctoc; then
|
|
echo "Installing doctoc globally..."
|
|
npm install -g doctoc
|
|
if [ $? -ne 0 ]; then
|
|
echo "Error: Failed to install doctoc"
|
|
exit 1
|
|
fi
|
|
fi
|
|
fi
|
|
|
|
echo "Updating table of contents in markdown files..."
|
|
|
|
# Find all markdown files that contain doctoc markers
|
|
find . -type f -name "*.md" -exec grep -l "START doctoc" {} \; | while read -r file; do
|
|
echo "Processing: $file"
|
|
doctoc --maxlevel 4 --no-title --notitle --github "$file"
|
|
|
|
if [ $? -ne 0 ]; then
|
|
echo "Error: Failed to update TOC in $file"
|
|
fi
|
|
done
|
|
|
|
echo "Table of contents update complete!"
|