skills.rest
SpineEventEngine
SpineEventEngineOFFICIAL
Explore all skills by this author →
Website𝕏@SpineEngineGitHub

check-links

Validate Hugo documentation links by rendering the site and scanning HTML with Lychee.

2|Updated May 28, 2021
Search Tags:#documentation#hugo#link validation#lychee#ci checks#broken urls#dev build verification
One-click install
npx skills add https://github.com/SpineEventEngine/validation --skill check-links-spineeventengine
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: check-links
Source: https://github.com/SpineEventEngine/validation/tree/main/.agents/skills/check-links
Command: npx skills add https://github.com/SpineEventEngine/validation --skill check-links-spineeventengine

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Broken links in your Hugo documentation waste time by failing CI and reducing trust in the docs, so this Skill proactively verifies that rendered site URLs resolve correctly.

Core Features & Use Cases

  • Builds and renders the Hugo site using the repo’s Hugo setup so link checks run against the same HTML output you ship.
  • Runs Lychee link validation over the rendered HTML to detect 404s, unreachable hosts, and other broken URL results.
  • Scopes checks to relevant changes (docs/site content and lychee.toml) to keep runs fast, and reports broken links grouped by the originating Markdown page.

Quick Start

Ask the Skill to check doc links for changes under docs and site by running it on your current branch.

Frequently Asked Questions about check-links

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find broken links in Hugo documentation before CI runs?▼

To find broken links in Hugo documentation, render the site in development mode and scan the HTML output with Lychee. This validates URLs under docs or site resolve correctly, grouping broken links by source Markdown page.

Do I need Lychee installed to validate documentation URLs in CI?▼

You do not need Lychee pre-installed to validate documentation URLs. The process requires Hugo and Node/npm availability, and will auto-download a pinned Lychee version if the tool is missing from the environment.

Can I scope link checks to only docs and site content changes?▼

You can scope link checks to only docs and site content changes. Validation targets Hugo documentation links under docs/ or site/ and lychee.toml modifications, keeping runs fast by skipping unrelated repository updates.

Why does CI Check Links fail on my Hugo site build?▼

CI Check Links fails on your Hugo site build when rendered documentation URLs return 404s or unreachable hosts. Running Lychee over the rendered HTML output proactively identifies these broken URLs grouped by source page.

What are the limitations of running Hugo link validation locally?▼

Limitations of Hugo link validation include requiring Hugo and Node/npm availability in the environment. It operates with safe read-only behavior over tracked sources, meaning it validates rendered output without modifying original Markdown files.

Related Skills

Explore More Content & Communication Skills→
drmowinckelsdrmowinckels

hugo-tailwind-theme

Bundle Tailwind CSS, Alpine.js, and vendor assets into self-contained Hugo themes.

Community
Advanced
terrylicaterrylica
62

link-validation

Scan markdown files with lychee to detect broken links and path policy violations.

Community
Intermediate
nq-rdlnq-rdl

lychee

Identify and report broken links in Markdown, HTML, YAML, and text files.

Official
Intermediate
notquenotque
415

link-auditor

Extract Hugo site links and generate structured audit reports.

Community
Advanced