Aria Docs

Ariadocs - шаблон документации

Этот шаблон документации, насыщенный функциями, построенный из Next.js, предлагает гладкий и отзывчивый дизайн, который идеально подходит для всех потребностей в документации вашего проекта.

Вот все версии шаблона Ariadocs, каждый из которых создан для конкретных вариантов использования:

• Расширенные документы: комплексный шаблон, предлагающий обширные функции для углубленных потребностей документации. Идеально подходит для более крупных проектов, которые требуют подробных объяснений и передовых конфигураций.
  Изучите продвинутые документы

• Версия Lite: обтекаемый шаблон без излишеств, идеально подходящий для простых потребностей документации.
  Изучите версию Lite

• Версия с версией: мощный вариант для проектов, которые требуют исторического отслеживания документации. Управляйте несколькими версиями ваших документов без усилий.
  Проверьте функцию версии

• Версия поддержки I18N (WIP): разработанная для международной аудитории, эта версия предложит комплексную многоязычную поддержку.
  Предварительный просмотр поддержки I18N

Быстрый старт

Вы можете создать новый проект Ariadocs, используя команду:

 npx create-aria-doc <project-directory>

Ожидаемый выход

Когда вы запускаете CLI, вы можете ожидать, что вывод, аналогичный этим:

 Creating a new Ariadocs project in /path/to/your/project from the master branch...
Cloning Master (Full Documentation)...
Ariadocs project successfully created in /path/to/your/project!

Next steps:
1. Navigate to your project directory:
   cd <project-directory>
2. Install dependencies:
   // To support React 19, package maintainers will need to test and update their packages to include React 19 as a peer dependency. This is already in progress.
   npm install --force 
3. Start the development server:
   npm run dev

Начиная

Во -первых, запустите сервер разработки:

 npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Развернуть на Vercel

Самый простой способ развернуть ваше приложение.

Ознакомьтесь с нашей документацией по развертыванию Next.js для получения более подробной информации.

Ключевые функции

Особенность	Описание
Поддержка MDX	Напишите интерактивную документацию с MDX.
Вложенные страницы	Организовать содержание в вложенной иерархической структуре.
Раздел блога	Включите выделенный раздел блога.
Оглавление	Автопогенерированный TOC для легкой навигации.
Страница	Разделение контента на нескольких страницах.
Синтаксис выделение	Выделите код для лучшей читаемости.
Подсветка и названия кода	Выделите конкретные строки с описательными названиями.
Интерактивные кодовые блоки	Языковой и интерактивный дисплей кода.
Пользовательские компоненты	Внедряют пользовательские, многоразовые компоненты в ваши документы.
Свет и темный режим	Переключить между легкими и темными темами.
Функциональность поиска	Быстро найти контент со встроенным поиском.
Кодовый переключатель	Переключение между языками кода или вариациями.
Код копия	Скопируйте блоки кода одним щелчком.
TOC Observer Hight	Выделите активные разделы в TOC во время прокрутки.
Статическое поколение сайта	Создайте статический, высокопроизводительный сайт.
Seo-Optimized	Структурирован для оптимальной индексации поисковой системы.

Дополнительные темы