К содержанию

Навигация

Проверка сборки

docara verify-static проверяет готовую сборку и печатает отчёт в JSON. Каждая проблема — запись в списке broken:

JSON
{"page": "ru/start/index.html", "reference": "../guide/#setup", "target": "@missing-fragment:setup"}
  • page — страница с ошибкой или @build, если ошибка относится ко всей сборке;
  • reference — ссылка из страницы или отметка проверки, начинающаяся с @;
  • target — куда ведёт ссылка, отметка или пояснение.

Если в записи нет отметки @, это обычная сломанная ссылка: файла по адресу target в сборке нет. Исправьте ссылку в исходном Markdown и пересоберите сайт. Подробнее о проверке — на странице Проверка результата.

Большинство отметок ниже означает, что каталог сборки изменили после docara build или собрали другой версией Docara. Тогда пересоберите сайт той же версией и не правьте файлы в build_*.

Ссылки и якоря

Эти ошибки обычно исправляются в Markdown.

Отметка Причина и что сделать
@missing-fragment Ссылка ведёт на якорь #..., которого нет на странице. Имя якоря стоит после двоеточия. Что сделать: Найдите настоящий id заголовка в собранной странице и исправьте ссылку. Якорь меняется, когда меняется текст заголовка.
@duplicate-html-id На странице два элемента с одинаковым id, обычно два одинаковых заголовка. Что сделать: Переименуйте один из заголовков.
@unsafe-fragment-encoding Якорь в ссылке закодирован неверно: сломанные %XX или не UTF-8. Что сделать: Пишите якорь обычным текстом или исправьте кодировку.
@unsafe-percent-encoding В пути ссылки неверные %XX. Что сделать: Исправьте путь в ссылке.
@unsafe-decoded-path-segment После раскодирования путь содержит /, \ или ... Что сделать: Используйте обычный путь без закодированных разделителей.
@outside-root Относительная ссылка уходит выше корня сайта через ../. Что сделать: Укажите путь от корня сайта: /раздел/страница/.
@outside-deployment-base Ссылка от корня /... ведёт за пределы base_url. Что сделать: Проверьте base_url или укажите путь внутри сайта.
@html-fragment-inventory Страницу не удалось разобрать, чтобы собрать её id. Что сделать: Пересоберите сайт. Если ошибка повторяется, сообщите о ней.
@unreadable HTML-файл сборки не читается. Что сделать: Проверьте права на файлы и пересоберите сайт.

Содержимое сборки

Отметка Причина и что сделать
@unsafe-artifact-entry В сборке есть символическая ссылка, жёсткая ссылка или специальный файл. Что сделать: Удалите их из assets/ и содержимого, затем пересоберите сайт.
@build-receipts-in-output В опубликованном каталоге лежит служебный каталог .docara/. Он должен лежать рядом со сборкой, а не в ней. Что сделать: Пересоберите сайт и не копируйте .docara/ в публикуемый каталог.
@html-base-element На странице есть тег <base>. Что сделать: Уберите его: Docara строит ссылки без <base>.
@page-build-identity Служебные метки страницы — язык, версия документации — не совпадают с планом сборки. Что сделать: Пересоберите сайт целиком.
@resolved-page-plans Нет или повреждён план собранных страниц. Что сделать: Пересоберите сайт целиком.
@standalone-examples Файлы изолированных примеров не совпадают с описанием сборки. Что сделать: Пересоберите сайт целиком.
@discovery-files sitemap.xml, robots.txt или llms.txt не совпадают с ожидаемыми, или ссылка из llms.txt ведёт на отсутствующий файл. Что сделать: Пересоберите сайт. Файлы из discovery.llms_links, которые пишет отдельный скрипт, создайте до проверки.

Поиск, языки и перенаправления

Отметка Причина и что сделать
@search-artifacts-missing Поиск включён, но в _docara/ нет файлов поиска. Что сделать: Пересоберите сайт.
@search-artifacts-unexpected Поиск выключен, но файлы поиска или ссылки на них остались. Что сделать: Пересоберите сайт в чистый каталог.
@search-index-contract Индекс поиска не совпадает со страницами сборки. Что сделать: Пересоберите сайт целиком.
@locale-route-contract Перенаправления между языками не совпадают с настройками locale_routing. Что сделать: Пересоберите сайт целиком.
@redirect-contract Страницы перенаправлений не совпадают с redirects.json. Что сделать: Пересоберите сайт целиком.

SIMAI Framework и каталог компонентов

Отметка Причина и что сделать
@framework-asset-projection, @framework-shell-asset, @vendor-asset-selection Файлы SIMAI Framework в _docara/ не совпадают с закреплёнными в simai-framework.lock.json. Что сделать: Пересоберите сайт. Не правьте файлы в _docara/.
@framework-shell-stylesheet, @site-theme-stylesheet Стили оформления или темы сайта изменены после сборки. Что сделать: Пересоберите сайт.
@framework-preload-order, @framework-preload-contract Порядок предзагрузки файлов SIMAI Framework на странице не совпадает с ожидаемым. Что сделать: Пересоберите сайт.
@component-catalog-contract, @component-index-contract, @public-registry-schema-projections Каталог компонентов или справочник схем на сайте не совпадает с пакетом Docara. Что сделать: Пересоберите сайт той же версией Docara, что установлена в проекте.

Код ошибки вместо отметки

Код Причина и что сделать
PREVIEW_BUILD_PURPOSE_FORBIDDEN Проверяется каталог предпросмотра, а не публикуемая сборка. Что сделать: Соберите сайт командой docara build production и проверьте build_production.

Поиск по документации

Введите минимум 2 символа

    Настройки

    Тема
    Размер шрифта
    Ширина страницы