DocFX Manager - расширение для VS Code, которое упрощает работу с DocFX-документацией: структура, ссылки, проверка качества и быстрый просмотр результата.
Для чего это нужно
Когда в проекте много Markdown-страниц, toc.yml, xref-ссылок и ассетов, расширение собирает все это в единый рабочий процесс прямо в редакторе. Меньше ручной рутины, меньше пропущенных ошибок, быстрее навигация по документации.
Возможности
Дерево документации: TOC + Markdown
Строит структуру из docs/toc.yml или корневого toc.yml.
Дает удобное управление узлами TOC и .md файлами.
Поддерживает drag-and-drop для переупорядочивания и переноса между TOC.
Позволяет переименовывать и удалять элементы дерева.
Создает новые страницы из шаблонов и автоматически добавляет их в ближайший toc.yml.
Вывод ошибок DocFX и интеграция с Problems
Показывает ошибки в панели Doc Health с группировкой по типам.
Дублирует диагностические сообщения в стандартную панель Problems VS Code.
Логирует и подсвечивает ключевые проблемы: отсутствие uid в front matter, неразрешенные локальные xref, отсутствующие локальные ассеты (например, изображения по относительному пути).
По клику на проблему открывает файл и сразу переводит к нужной строке.
Правый таб: инспектор страницы
Для активного Markdown-файла показывает заголовки и структуру разделов, xref-ссылки с быстрым переходом по UID, обычные ссылки и изображения.
Сразу видно, какие ссылки/ассеты валидны, а какие сломаны.
Онлайн-превью (Live Preview)
Рендерит Markdown в отдельной панели в реальном времени.
Позволяет переходить по xref прямо из превью.
Открывает внутренние документы и файлы по ссылкам.
Корректно обрабатывает внешние ссылки.
Отмечает неразрешенные xref и отсутствующие цели ссылок.
Синхронизация TOC
При изменении title в Markdown обновляет имя элемента в TOC.
При переименовании .md автоматически обновляет соответствующий href в TOC.
Навигация и ускорение работы
Индексирует UID и метаданные Markdown-страниц.
Дает быстрый поиск по названию, UID и пути.
Поддерживает автодополнение для xref в Markdown.
Настройка
docfx-manager.health.includeExternalXrefs (false по умолчанию)
Если включить, в проверку здоровья также попадут внешние или нелокальные xref.
