Skip to content

Commit 6294dc7

Browse files
authored
Merge pull request Azure#575 from likamrat/docs_fix
more script updates
2 parents 7c912d6 + 9f5f480 commit 6294dc7

File tree

2 files changed

+146
-61
lines changed

2 files changed

+146
-61
lines changed

scripts/python/url-checker/README.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@ This tool checks for broken URLs in all Markdown files within the repository. It
1111
- Image links
1212
- SVG image links
1313
- Markdown header links (`#header-name`)
14+
- Advanced header link validation:
15+
- Extracts actual headers from markdown files
16+
- Validates in-page links (`#header-name`)
17+
- Cross-file header links (`file.md#header-name`)
18+
- Smart directory link handling:
19+
- Detects links ending with `/`
20+
- Looks for default files (`_index.md`, `index.md`, `README.md`)
21+
- Fallback to any markdown file in the directory
1422
- Detailed output with categorization by link type
1523
- Colorized console output (including in GitHub Actions)
1624
- Comprehensive log files with summary tables
@@ -100,6 +108,9 @@ Link Validation Summary (6122 links checked):
100108
- Image URLs: 0
101109
- SVG URLs: 0
102110
- Header links: 0
111+
- No links found: 2 categories
112+
- Root-relative URLs
113+
- SVG URLs
103114
- OK links: 6080
104115
❌ Broken links were found. Check the logs for details.
105116
```
@@ -133,8 +144,7 @@ Runtime duration: 0:05:24.123456
133144
134145
// ... sections for other link types ...
135146
136-
===== LINK VALIDATION SUMMARY (6122 LINKS CHECKED) =====
137-
147+
Link Validation Summary (6122 links checked):
138148
- Broken links: 42
139149
- Absolute URLs: 8
140150
- Relative URLs without anchors: 0
@@ -143,11 +153,11 @@ Runtime duration: 0:05:24.123456
143153
- Image URLs: 0
144154
- SVG URLs: 0
145155
- Header links: 0
156+
- No links found: 2 categories
157+
- Root-relative URLs
158+
- SVG URLs
146159
- OK links: 6080
147-
148-
===== CONCLUSION: 42 BROKEN LINKS FOUND =====
149-
150-
❌ Broken links were found. Check the details above.
160+
❌ Broken links were found. Check the logs for details.
151161
```
152162

153163
## ⚙️ Configuration

0 commit comments

Comments
 (0)