Reactive EngineeringRE Docs
Архитектура

Архитектура

Как устроен шаблон Doc-Portal — от MDX-файла до отрендеренной страницы.

Портал — это приложение Next.js с файловой маршрутизацией, где содержимое документации хранится в репозитории рядом с кодом. Сборка превращает .mdx-файлы в типизированную коллекцию, а единственный динамический маршрут рендерит любую страницу документации.

Общая схема

Ключевые решения

РешениеОбоснование
Контент в репозитории, а не в CMSДокументация проходит тот же review, что и код; версия документации совпадает с версией продукта.
Один динамический маршрут [[...slug]]Новая страница не требует изменений в коде — достаточно .mdx-файла.
Структура из meta.json, а не из имен файловПорядок и названия разделов управляются явно, переименование файла не ломает навигацию.
Продукт = каталог с "root": trueFumadocs автоматически строит выпадающий список продуктов; добавление продукта — операция над содержимым, не над кодом.
Вся настройка в lib/portal.config.tsРазвертывание нового портала не требует правок в компонентах.
Брендовые токены в CSS-переменныхFumadocs UI читает --color-fd-*; переопределение палитры брендирует все встроенные компоненты сразу.

Подробнее

On this page