check_links

Notedocblock

check_links(docs_dir::String; timeout::Int=10, ignore_patterns::Vector{String}=String[], verbose::Bool=true) -> LinkCheckReport

Check all links in documentation files.

Arguments

• docs_dir::String: Directory containing documentation files
• timeout::Int: Timeout for each link check (default: 10 seconds)
• ignore_patterns::Vector{String}: URL patterns to skip (regex)
• verbose::Bool: Print progress messages (default: true)

Returns

LinkCheckReport with all results.

Example

# Check all links in docs/
report = check_links("docs")

# Check with ignores
report = check_links("docs";
    ignore_patterns=["localhost", "127\\.0\\.0\\.1"],
    timeout=5
)

# Print broken links
for r in report.results
    if r.status == :broken
        println("$(r.source_file):$(r.line_number) - $(r.url)")
    end
end