Skip to content

feat: validate anchors in links

Yaroslav Dynnikov requested to merge rosik/lint_headers into main

Summary

Мы используем расширение markdown attr_list чтобы явно задавать заголовкам якоря (anchors) и ссылаться на конкретный раздел. Выглядит это так:

## Общие сведения {: #intro }
См. [Общие сведения](#intro)

Данный патч добавляет проверки в процесс mkdocs build / serve

  • check_headers.py собирает список якорей и проверяет на дубликаты
  • check_links.py проверяет ссылки и следит чтобы страницы и якоря существовали

Пример проверки:

INFO    -  check_headers: MISSING ANCHOR @ tutorial/audit_log.md: # Использование журнала аудита
INFO    -  check_headers: INVALID ANCHOR @ tutorial/audit_log.md: ## Структура журнала {: audit-log-structure }
INFO    -  check_links: BROKEN LINK @ tutorial/access_control.md: [интерактивной консолью](../reference/clis.md#interactive)
INFO    -  check_links: BROKEN LINK ANCHOR @ reference/audit_events.md: [остановка](../reference/api.md#picoexit)

Коммиты

  • rename: filter_plugin_records -> hooks/filter_logs
  • feat: validate anchors in links

Саморевью

  • Контент отображается корректно
  • Ссылки в контенте работоспособны и корректны
Edited by Yaroslav Dynnikov

Merge request reports