Opensophy Docs

Opensophy Docs — шаблон документации на базе SvelteKit, разработанный как часть экосистемы Opensophy. Позволяет быстро развернуть брендированный сайт документации с навигацией, поиском, подсветкой кода, тёмной темой и полным набором SEO-метаданных.

Данный проект экосистемы Opensophy — личная инженерная разработка. Он открыт (open-source), но не предназначен для production-внедрения без кастомизации. Поддержка и SLA не предоставляются, без спонсирования или поддержки в пулл-реквестах.

Технологический стек

Технология	Назначение
SvelteKit	Фреймворк, SSR/SSG, маршрутизация
MDsveX	Markdown с поддержкой Svelte-компонентов (.svx)
Tailwind CSS v4	Стилизация, тёмная тема через CSS-переменные
Shiki	Подсветка синтаксиса в блоках кода
KaTeX	Рендеринг математических формул
carbon-icons-svelte	Иконки интерфейса

Возможности

Автонавигация — структура меню строится из имён файлов и директорий без конфигурации
Два режима страниц — Markdown (.svx) для контента и .svelte для кастомных страниц
Категории и разделы — иерархическая структура через систему именования [N], [C], [A]
Поиск — встроенная командная палитра (Cmd/Ctrl+K)
Тёмная / светлая тема — переключение с сохранением в localStorage
Оглавление — автоматически генерируется из заголовков страницы
Подсветка кода — Shiki с поддержкой языка, копирования и метаданных
Компоненты Markdown — admonitions, cards, columns, steps, charts, tables
SEO — title, description, Open Graph, Twitter Card, JSON-LD, sitemap.xml, robots.txt, llms.txt
Пакетный менеджер — переключатель npm / pnpm / yarn в блоках установки
Mobile-ready — адаптивная навигация с мобильным сайдбаром

Для кого

Шаблон подходит для:

технической документации к библиотекам и инструментам
внутренних знаний команды (runbooks, архитектурные решения)
личных проектов, которым нужен профессиональный вид документации без создания с нуля

Структура проекта

apps/web/
├── src/
│   ├── lib/
│   │   ├── config/         ← branding.ts, site.ts, content-ui.ts
│   │   ├── content/
│   │   │   └── docs/       ← ваш контент (.svx файлы)
│   │   └── components/     ← UI компоненты
│   └── routes/             ← SvelteKit маршруты
└── static/                 ← логотипы, og-image, webmanifest

apps/web/
├── src/
│   ├── lib/
│   │   ├── config/         ← branding.ts, site.ts, content-ui.ts
│   │   ├── content/
│   │   │   └── docs/       ← ваш контент (.svx файлы)
│   │   └── components/     ← UI компоненты
│   └── routes/             ← SvelteKit маршруты
└── static/                 ← логотипы, og-image, webmanifest

Подробнее о настройке — в разделе Настройки.