Skip to content

Fix DocC resource paths in HTML tags #23

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
SoundBlaster merged 1 commit into from
Nov 11, 2025
Merged

Fix DocC resource paths in HTML tags #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 27 additions & 16 deletions .github/workflows/docc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,24 +59,35 @@ jobs:
echo "=== Generated file structure ==="
find DocsBuild -type f | head -20

# Debug: Find all files containing baseURL
echo "=== Files containing 'baseURL' ==="
grep -r "baseURL" DocsBuild --include="*.html" --include="*.js" || true

# Fix the baseURL in generated HTML and JavaScript files
# DocC's --hosting-base-path doesn't always set baseURL correctly, so we fix it manually
echo "=== Fixing baseURL in all relevant files ==="
find DocsBuild -type f \( -name "*.html" -o -name "*.js" \) | while read -r file; do
sed -i '' 's|"baseURL":"/"|"baseURL":"/'$DOCC_HOSTING_BASE_PATH'/"|g' "$file"
sed -i '' "s|'baseURL':'/'|'baseURL':'/$DOCC_HOSTING_BASE_PATH/'|g" "$file"
sed -i '' 's|baseURL:"/"|baseURL":"/'$DOCC_HOSTING_BASE_PATH'/"|g' "$file"
sed -i '' 's|var baseUrl = "/"|var baseUrl = "/'$DOCC_HOSTING_BASE_PATH'/"|g' "$file"
sed -i '' 's|const baseUrl = "/"|const baseUrl = "/'$DOCC_HOSTING_BASE_PATH'/"|g' "$file"
# Debug: Show original index.html
echo "=== Original index.html (first 30 lines) ==="
head -30 DocsBuild/index.html || true

# Fix resource paths in HTML files
# DocC's --hosting-base-path doesn't add the base path to script/link tags in HTML
echo "=== Fixing resource paths in HTML files ==="
find DocsBuild -type f -name "*.html" | while read -r file; do
# Fix script src attributes
sed -i '' 's|src="/js/|src="/'$DOCC_HOSTING_BASE_PATH'/js/|g' "$file"
sed -i '' 's|src="/css/|src="/'$DOCC_HOSTING_BASE_PATH'/css/|g' "$file"
sed -i '' 's|src="/images/|src="/'$DOCC_HOSTING_BASE_PATH'/images/|g' "$file"

# Fix link href attributes
sed -i '' 's|href="/js/|href="/'$DOCC_HOSTING_BASE_PATH'/js/|g' "$file"
sed -i '' 's|href="/css/|href="/'$DOCC_HOSTING_BASE_PATH'/css/|g' "$file"
sed -i '' 's|href="/images/|href="/'$DOCC_HOSTING_BASE_PATH'/images/|g' "$file"

# Fix favicon paths
sed -i '' 's|href="/favicon.ico"|href="/'$DOCC_HOSTING_BASE_PATH'/favicon.ico"|g' "$file"
sed -i '' 's|href="/favicon.svg"|href="/'$DOCC_HOSTING_BASE_PATH'/favicon.svg"|g' "$file"

# Fix data directory paths
sed -i '' 's|"/data/|"/'$DOCC_HOSTING_BASE_PATH'/data/|g' "$file"
done

# Debug: Verify the fix
echo "=== After fix: Files containing 'baseURL' ==="
grep -r "baseURL" DocsBuild --include="*.html" --include="*.js" | head -10 || true
# Debug: Show fixed index.html
echo "=== Fixed index.html (first 30 lines) ==="
head -30 DocsBuild/index.html || true

- name: Upload documentation artifact
if: github.event_name == 'push'
Expand Down