Files
www/dir2md.sh

113 lines
3.0 KiB
Bash
Raw Normal View History

2025-05-06 23:13:18 -04:00
#!/bin/sh
# Usage function for help
usage() {
cat << EOF
Usage: $(basename "$0") [directory] [output.md]
2025-05-06 23:17:33 -04:00
Generate a markdown-formatted directory listing with file links.
2025-05-06 23:13:18 -04:00
Arguments:
directory : Directory to scan (default: current directory)
output.md : Output markdown file (default: directory_listing.md)
EOF
exit 1
}
# Set default values
target_dir="${1:-.}"
output_file="${2:-directory_listing.md}"
# Validate directory
if [ ! -d "$target_dir" ]; then
echo "Error: Directory '$target_dir' does not exist." >&2
usage
fi
# Create or truncate the output file
: > "$output_file"
2025-05-06 23:17:33 -04:00
# Get absolute paths
target_dir=$(cd "$target_dir" && pwd)
output_dir=$(cd "$(dirname "$output_file")" && pwd)
output_name=$(basename "$output_file")
2025-05-06 23:13:18 -04:00
# Write header to the markdown file
{
2025-05-06 23:17:33 -04:00
echo "# Directory Listing: $target_dir"
2025-05-06 23:13:18 -04:00
echo "Generated on: $(date)"
echo
} >> "$output_file"
# Function to calculate the depth of a path
get_depth() {
printf "%s" "$1" | tr -c -d '/' | wc -c
}
2025-05-06 23:17:33 -04:00
# Function to create a relative path between two absolute paths
make_relative_path() {
# $1 is the path to the markdown file directory
# $2 is the path to the target file
# Start with both paths
common_path="$1"
target="$2"
# Initialize relative path
rel_path=""
# Find the common prefix
while [ "${target#$common_path/}" = "$target" ] && [ -n "$common_path" ]; do
common_path="${common_path%/*}"
rel_path="../$rel_path"
done
# If there's no common path left, we've gone up as far as we need to
if [ -z "$common_path" ]; then
rel_path="/$target"
else
# Remove the common prefix and prepend the relative path
rel_path="${rel_path}${target#$common_path/}"
fi
printf "%s" "$rel_path"
}
2025-05-06 23:13:18 -04:00
# Main function to generate the listing
generate_listing() {
find "$target_dir" -print | sort | while read -r item; do
# Skip the target directory itself
[ "$item" = "$target_dir" ] && continue
# Calculate relative path and depth
rel_path="${item#$target_dir/}"
depth=$(get_depth "$rel_path")
# Calculate indentation (2 spaces per level)
indent=""
i=0
while [ $i -lt "$depth" ]; do
indent="$indent "
i=$((i + 1))
done
# Get the basename of the item
base_name=$(basename "$item")
2025-05-06 23:17:33 -04:00
# Create relative link path from output file to target
link_path=$(make_relative_path "$output_dir" "$item")
2025-05-06 23:13:18 -04:00
# Generate the markdown line
if [ -d "$item" ]; then
# Directory: add trailing slash and make it bold
2025-05-06 23:17:33 -04:00
echo "${indent}- **[${base_name}/](${link_path}/)**" >> "$output_file"
2025-05-06 23:13:18 -04:00
else
2025-05-06 23:17:33 -04:00
# Regular file: create a link
echo "${indent}- [${base_name}](${link_path})" >> "$output_file"
2025-05-06 23:13:18 -04:00
fi
done
}
# Generate the listing
generate_listing
echo "Directory listing has been saved to: $output_file"