Проверка ссылок в Markdown
Наткнулся на довольно неплохую утилиту, которой просто проверить папку с ворохом .md и/или HTML файлов на наличие битых ссылок. Для маленького количества файлов проще проверить глазами, да и вряд ли там будет много кросс-ссылок, для большой документации скорее всего будет использоваться что-то вроде MkDocs со встроенными средствами и/или плагинами. А вот для среднего количества — самое то.
Онлайн запросы скорее всего вряд ли будут иметь смысл (а если репозиторий публичный, то это еще и дырка потенциальная). Одна из киллерфич — проверка якорей (/blabla#header
). Поэтому проверка выглядит примерно так:
lychee --offline --include-fragments '**/*.md'
Если есть сгенерированный контент, то лучше запускать на отрендеренном сайте.
Есть и GitHub Action, пример на моем репозитории тут — при подключении нашлось аж 3 ошибки.
UPD: a после исправления командной строки, чтобы поддерживались относительные ссылки, нашлась еще пара косяков.