Современная документация для проекта RAT Community (Remote API for Testing) - расширения для автоматизации тестирования в 1С:Предприятие через REST API. Документация создана с помощью Docusaurus с поддержкой подсветки кода 1С и поисковой системы.

Каталог doc/ содержит полную документацию проекта RAT Community, включающую:

• Инструкции по установке и настройке
• Описание архитектуры и API
• Руководства по разработке и внесению вклада
• Описание функциональности и возможностей
• Примеры использования и интеграции

• 🎨 Современный дизайн - Адаптивный интерфейс с поддержкой темной/светлой темы
• 🔍 Поиск - Интеграция с Algolia DocSearch для быстрого поиска по документации
• 💻 Подсветка кода 1С - Специальная поддержка языка 1С (BSL) с помощью Shiki
• 📱 Мобильная версия - Полная поддержка мобильных устройств
• 🚀 Быстрая загрузка - Оптимизированная производительность
• 🔧 Кастомизация - Легкая настройка и расширение функциональности
• 📊 Mermaid диаграммы - Поддержка создания схем и диаграмм

cd doc
npm install

# Запуск в режиме разработки с hot reload
yarn start
# Документация будет доступна по адресу: http://localhost:3000

# Проверка типов TypeScript
yarn typecheck

# Сборка статического сайта для продакшена
yarn build

# Очистка кэша сборки
yarn clear

# Локальный просмотр собранной версии
yarn serve

# Публикация на GitHub Pages
yarn deploy

# Генерация переводов (если используется i18n)
yarn write-translations

# Генерация ID для заголовков
yarn write-heading-ids

# Кастомизация компонентов темы
yarn swizzle

doc/
├── docs/                         # 📄 Основная документация
│   ├── install/                  # 🔧 Инструкции по установке и настройке
│   ├── architecture/             # 🏗️ Архитектура системы
│   ├── functionality/            # ⚙️ Описание функциональности
│   ├── contributing/             # 👨‍💻 Руководство по разработке
│   └── README.md                 # 📋 Главная страница документации
├── src/
│   ├── components/               # ⚛️ React компоненты
│   │   └── HomepageFeatures/     # 🏠 Компоненты главной страницы
│   ├── css/                      # 🎨 Пользовательские стили
│   │   └── custom.css            # Основные стили документации
│   └── pages/                    # 📄 Дополнительные страницы
│       ├── index.tsx             # Главная страница сайта
│       └── index.module.css      # Стили главной страницы
├── static/                       # 📁 Статические файлы
│   └── img/                      # 🖼️ Изображения и иконки
├── docusaurus.config.ts          # ⚙️ Конфигурация Docusaurus
├── sidebars-autogenerated.ts     # 🧭 Автогенерируемая навигация
├── package.json                  # 📦 Зависимости Node.js
└── tsconfig.json                 # 🔧 Конфигурация TypeScript

1. Перейдите на Algolia DocSearch
2. Заполните форму для вашего сайта
3. Получите API ключи
4. Обновите docusaurus.config.ts

npm install @docusaurus/theme-search-local

Редактируйте src/css/custom.css для изменения внешнего вида.

Добавляйте новые React компоненты в src/components/ и используйте их в MDX файлах.

Используйте @docusaurus/theme-classic как основу и кастомизируйте по необходимости.

yarn deploy

• Netlify: Подключите репозиторий и укажите команду сборки
• Vercel: Автоматическое определение настроек Docusaurus
• Docker: Используйте предоставленный Dockerfile

• Docusaurus 3.9.1 - Генератор статических сайтов для документации
• React 19.0.0 - UI библиотека для компонентов
• TypeScript 5.6.2 - Типизированный JavaScript
• MDX - Markdown с поддержкой JSX компонентов

• Shiki 3 - Подсветка синтаксиса кода
• @shikijs/rehype - Интеграция с Rehype
• Поддержка языков: BSL (1С), JSON, Gherkin, JavaScript, SQL
• Темы: GitHub Light (светлая), Monokai (темная)

• Algolia DocSearch - Поиск по документации
• Автогенерация навигации - На основе структуры файлов
• Контекстный поиск - Умный поиск с учетом контекста

• Mermaid - Создание диаграмм и схем
• SVG изображения - Векторная графика для схем архитектуры

• Node.js: >= 20.0
• npm: Последняя стабильная версия
• Браузеры: Chrome, Firefox, Safari (последние 3-5 версий)

• GitHub Issues: Сообщить о проблеме
• Исходный код: GitHub репозиторий

Создано с ❤️ сообществом разработчиков 1С