EpoCanvas Docs

Быстрая навигация и описание возможностей

Обзор продукта и ключевые преимущества

Предыстория появления EpoCanvas Docs, решаемые задачи, ключевые возможности и честное сравнение с другими популярными инструментами документации.

Читать обзор продукта Список возможностей, сценарии применения и замысел проекта.

Быстрый старт за 3 минуты

Несколько команд — и зависимости установлены на локальном компьютере, а сервер разработки с горячей перезагрузкой запущен: пишете Markdown и сразу видите результат. Не хотите ставить окружение? Нажмите кнопку развёртывания в один клик и опубликуйте демо-сайт в своём облачном аккаунте.

Открыть руководство по быстрому старту Кнопка развёртывания в один клик, шаги установки и основные команды.

Интерфейс и взаимодействие

Понятная трёхколоночная вёрстка: «навигация по категориям слева + основной текст по центру + оглавление текущей страницы справа». Позиция прокрутки сохраняется при переходах между страницами, интерфейс адаптируется и под телефон, и под компьютер.

Подробнее о макете интерфейса Структура трёхколоночного макета, переключение темы и типографика.

Поиск по странице и по всему сайту

Поле поиска в верхней панели находит текст на текущей странице, а Ctrl+K / Cmd+K открывает окно полнотекстового поиска по всему сайту. Всё выполняется локально в браузере.

Подробнее о поиске Использование двух режимов поиска и принцип работы локального индекса.

Полные переводы на 10 языков

Навигация, боковая панель и основной текст каждой статьи доступны на 10 языках, включая упрощённый и традиционный китайский, английский и японский. Нажмите язык в правом верхнем углу страницы, чтобы перейти к той же статье на нужном языке.

Подробнее о многоязычности Список поддерживаемых языков, способ переключения и порядок добавления новых переводов.

Руководство по написанию Markdown

Где хранить файлы, правила Frontmatter и полный список поддерживаемых форматов — базовый Markdown и расширенный синтаксис; для каждого пункта показано, как писать, и реальный результат рендеринга.

Читать руководство по форматированию Базовые форматы и весь расширенный синтаксис.

Подробно о правилах рендеринга

Полный конвейер рендеринга Markdown от файла до страницы, все соглашения по выноскам, блокам кода, изображениям и ссылкам, а также неподдерживаемый синтаксис.

Открыть правила рендеринга Конвейер рендеринга, соглашения по синтаксису и типичные заблуждения.

Компоненты интерфейса и доработка

Назначение и поток данных семи кастомных компонентов, механизм переопределения Starlight и что нужно учитывать при доработке.

Подробнее о компонентах Архитектура компонентов, детали реализации и регрессия при обновлениях.

Шпаргалка по типовым доработкам

Частые доработки — новая статья, кнопка навигации, язык интерфейса, цвет темы, логотип — просто выполняйте шаги по порядку.

Открыть шпаргалку по доработкам Полные пошаговые инструкции по восьми рецептам.

Развёртывание и частые вопросы

Кнопки развёртывания в один клик и руководства по ручному развёртыванию для Cloudflare, Vercel и Netlify, привязка собственного домена, а также способы проверки результата развёртывания и чек-лист типичных ошибок.

Открыть развёртывание и FAQ Команды публикации, привязка домена и FAQ.

SEO и оптимизация производительности

Встроенные meta-теги, Open Graph, sitemap и robots.txt, описание механизмов производительности и шаги для добавления сайта в поисковые системы.

Открыть руководство по SEO Проверка индексации и самостоятельная проверка производительности.