Automatically Check Obsidian for Broken Links with lychee

Описание и применение

Автоматически проверяйте внутренние ссылки в Obsidian с помощью lychee, используя относительные Markdown‑ссылки, pre‑commit‑хуки и GitHub Actions.

Задача

Renaming or deleting notes in Obsidian can leave broken links that are hard to detect manually.

Результат

The vault is automatically scanned for broken links, with failures reported in the terminal, pre‑commit aborts commits, and CI prevents PR merges until links are fixed.

Рабочий процесс

• Configure Obsidian to use relative Markdown links
• Install lychee via Homebrew or curl
• Create a .lycheeignore or lychee.toml to exclude non‑vault files
• Run lychee --offline vault/ to scan locally
• Set up a pre‑commit hook with pre‑commit to run lychee on every commit
• Add a GitHub Actions workflow to run lychee in CI

Доказательства

When you manage notes in Obsidian, renaming or deleting notes can leave broken links behind.

Источник

Obsidian's default wiki-link format [[note]] is not supported. To check links with lychee, you need to use standard Markdown link syntax.

Источник

lychee --offline vault/

Источник

Now the link check runs automatically on every commit, and the commit will be aborted if any broken links are found.

Источник

Running the link check in CI catches problems before a PR is merged.

Источник