Reactive EngineeringRE Docs
Быстрый старт

Структура репозитория

Назначение каталогов и ключевых файлов шаблона 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.pngFavicon портала: знак R/E на брендовом градиенте.
app/docs/layout.tsxLayout документации: дерево страниц и выпадающий список продуктов.
app/docs/[[...slug]]/page.tsxРендерер всех MDX-страниц: заголовок, TOC, кнопки Markdown и GitHub, SEO.
app/api/search/route.tsEndpoint полнотекстового поиска.
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.tsMarkdown-представление отдельной страницы.
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.tsContent negotiation: отдает Markdown для /docs/*.md и клиентов, предпочитающих Markdown.

Документация о самом шаблоне

РасположениеАудитория
docs/*.mdРазработчики, работающие с репозиторием. Читается прямо в Git.
content/docs/doc-portal/**Пользователи портала. Публикуется на сайте.
AGENT.mdКонтекст проекта для AI-агентов и новых участников команды.
README.mdОбзор проекта, быстрый старт и карта документации.

On this page