Быстрый старт
Структура репозитория
Назначение каталогов и ключевых файлов шаблона Doc-Portal.
Дерево репозитория
layout.tsx
page.tsx
global.css
icon.png
mdx.tsx
placeholder-page.tsx
meta.json
index.mdx
portal.config.ts
brand.ts
shared.ts
layout.shared.tsx
source.ts
cn.ts
AGENT.md
README.md
DEPLOYMENT.md
source.config.ts
next.config.mjs
proxy.ts
Dockerfile
Маршруты приложения
| Путь | Назначение |
|---|---|
app/layout.tsx | Корневой layout: подключение шрифтов, глобальные metadata, провайдер темы. |
app/page.tsx | Главная страница /: hero-блок, карточки продуктов и связанных порталов. |
app/global.css | Брендовые токены, переопределение палитры Fumadocs, типографика, утилиты. |
app/icon.png | Favicon портала: знак R/E на брендовом градиенте. |
app/docs/layout.tsx | Layout документации: дерево страниц и выпадающий список продуктов. |
app/docs/[[...slug]]/page.tsx | Рендерер всех MDX-страниц: заголовок, TOC, кнопки Markdown и GitHub, SEO. |
app/api/search/route.ts | Endpoint полнотекстового поиска. |
app/og/docs/[...slug]/route.tsx | Генерация Open Graph-изображений в брендовых цветах. |
app/llms.txt/route.ts | Краткий индекс документации для LLM. |
app/llms-full.txt/route.ts | Полное содержимое всех страниц одним файлом. |
app/llms.mdx/docs/[[...slug]]/route.ts | Markdown-представление отдельной страницы. |
app/swagger/page.tsx, app/flows/page.tsx | Страницы-заглушки связанных порталов. |
Конфигурация
| Файл | Назначение |
|---|---|
lib/portal.config.ts | Единственный файл, который нужно править при развертывании нового портала: название, описание, репозиторий, список продуктов, связанные порталы. |
lib/brand.ts | Брендовые константы Reactive Engineering: палитра, градиент, пути к ассетам, шрифты. |
lib/shared.ts | Плоские экспорты, производные от portal.config.ts, и построение GitHub-ссылок. |
lib/layout.shared.tsx | Общая верхняя навигация с логотипом. |
lib/source.ts | Загрузчик коллекции Fumadocs, дерево страниц, вспомогательные URL. |
source.config.ts | Описание MDX-коллекции, схемы frontmatter и meta.json, remark-плагины. |
next.config.mjs | Конфигурация Next.js: MDX и standalone-сборка. |
proxy.ts | Content negotiation: отдает Markdown для /docs/*.md и клиентов, предпочитающих Markdown. |
Документация о самом шаблоне
| Расположение | Аудитория |
|---|---|
docs/*.md | Разработчики, работающие с репозиторием. Читается прямо в Git. |
content/docs/doc-portal/** | Пользователи портала. Публикуется на сайте. |
AGENT.md | Контекст проекта для AI-агентов и новых участников команды. |
README.md | Обзор проекта, быстрый старт и карта документации. |

