简体中文 · English · 日本語 · 한국어 · Español · Français · Deutsch · Português · Русский · 繁體中文

• ❌ Официальная документация отстаёт, следуя инструкциям, но ничего не работает?
• ❌ Учебники в интернете — это копирование и вставка, код вообще не запускается?
• ❌ Возникла ошибка, но решения найти не удаётся?
• ❌ Хотите углубиться, но не находите практических руководств на уровне исходного кода?

OpenCodeDocs специально создан для решения этих проблем.

Не скопировано из интернета, а выведено из реального исходного кода

Мы проводим глубокий анализ исходного кода открытых проектов, гарантируя, что каждая строка кода автоматически проверена. В учебниках указаны конкретные версии Git Commit, чтобы вы точно знали, на какой версии основан код.

Инструмент обновился — учебник тоже автоматически обновился

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

💡 Наши учебники активно обновляются, мы постоянно добавляем новые качественные проекты!

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

Независимо от того, откуда вы, вы можете изучать инструменты AI на родном языке.

Следуйте инструкциям, получите результат с первого раза, без догадок и проб

Каждый шаг учебника проверен, от установки до развёртывания. Просто следуйте инструкциям — всё заработает. Без лишних усилий, без ловушек, без лишних проблем.

Не умеете устанавливать? Не умеете настраивать? Не волнуйтесь, у нас есть пошаговые учебники

• Подойдёт даже для новичков
• Каждый шаг подробно объяснён
• Для всех распространённых ошибок есть решения

Хотите продвинуться? Мы углубимся в исходный код

• Техники ротации нескольких аккаунтов
• Секреты экономии токенов
• Практика автоматизации агентов
• Глубокий анализ на уровне исходного кода

Командной работе нужны единые стандарты?

• Повторяемые лучшие практики
• Полная структура проекта
• Руководство по развёртыванию в производственной среде

git clone https://github.com/vbgate/opencodedocs.git
cd opencodedocs/site

npm install

npm run dev

Откройте http://localhost:5173 и начните своё обучение AI-инструментам! 🎉

💡 Подсказка: Вы также можете посетить opencodedocs.com для просмотра онлайн-документации.

site/
├── docs/                      # Корневой каталог документации
│   ├── zh/                    # Учебники на китайском 🇨🇳
│   ├── en/                    # Учебники на английском 🇺🇸
│   ├── ja/                    # Учебники на японском 🇯🇵
│   ├── ko/                    # Учебники на корейском 🇰🇷
│   ├── es/                    # Учебники на испанском 🇪🇸
│   ├── fr/                    # Учебники на французском 🇫🇷
│   ├── de/                    # Учебники на немецком 🇩🇪
│   ├── pt/                    # Учебники на португальском 🇵🇹
│   ├── ru/                    # Учебники на русском 🇷🇺
│   ├── zh-tw/                 # Учебники на традиционном китайском 🇹🇼
│   ├── .vitepress/            # Конфигурация VitePress
│   │   ├── config.mts         # Основной файл конфигурации
│   │   ├── sidebar.config.ts  # Автоматическая генерация боковой панели
│   │   └── theme/             # Кастомные компоненты темы
│   ├── about.md               # О нас
│   └── terms.md               # Условия использования
├── scripts/                   # Инструментальные скрипты
│   ├── add-order-to-md.ts     # Добавление поля сортировки
│   ├── check-frontmatter.ts   # Проверка Frontmatter
│   └── create-category-indexes.ts  # Создание индексов категорий
├── package.json               # Конфигурация проекта
├── tailwind.config.js         # Конфигурация Tailwind CSS
└── postcss.config.js          # Конфигурация PostCSS

Технология	Версия	Описание
	1.x	Генератор статических сайтов · Молниеносная сборка
	3.4+	Фреймворк · Composition API
	4.x	Система стилей · CSS-first конфигурация
	5.9+	Типобезопасность · Проверка при компиляции
	11.x	Поддержка диаграмм · Визуализация схем
	Pages	Глобальный CDN · 200+ граничных узлов

1. Создание структуры каталогов

   docs/zh/[owner]/[repo]/
   ├── index.md          # Главная страница проекта
   ├── start/            # Быстрый старт
   ├── features/         # Описание функций
   └── faq/              # Часто задаваемые вопросы

2. Написание Frontmatter

   ---
   title: "Заголовок учебника"         # 2-6 китайских иероглифов
   order: 10                          # Сортировка (10, 20, 30...)
   sidebarTitle: "Заголовок боковой панели"  # Опционально
   description: "SEO описание"        # Оптимизация для поисковых систем
   ---

3. Проверка сборки

   npm run docs:build

Добавьте проект в docs/.vitepress/sidebar.config.ts:

const projects = [
  'owner/repo',  // Добавьте ваш проект
]

Затем переведите файл home-config.[lang].json.

• Расположение компонентов: docs/.vitepress/theme/components/
• Файлы стилей: docs/.vitepress/theme/custom.css
• Tailwind v4: Используйте CSS-first подход к конфигурации

npm run docs:build

Результаты сборки находятся в каталоге docs/.vitepress/dist/.

# Автоматическое развёртывание
npm run deploy

npm run docs:preview

• Оптимизация изображений: Используйте формат WebP, сжимайте до 200 КБ
• Разделение кода: VitePress автоматически разделяет по маршрутам
• Ускорение CDN: Статические ресурсы автоматически загружаются на Cloudflare CDN
• Предварительный рендеринг: Ключевые страницы предрендерены, загрузка первого экрана < 500 мс

✅ Наш сайт развёрнут на глобальном CDN, скорость доступа молниеносна!

Мы приветствуем вклад сообщества! Отправляйте свои учебники, исправляйте ошибки, добавляйте новые функции.

1. Fork этого репозитория

   # Нажмите кнопку Fork на странице GitHub

2. Создание ветки для новой функции

   git checkout -b feature/amazing-feature

3. Фиксация изменений

   git commit -m 'Add amazing feature'

4. Отправка в ветку

   git push origin feature/amazing-feature

5. Отправка Pull Request

• Нажмите кнопку "Pull Request" на странице GitHub
• Заполните описание PR, объясните свои изменения

🌟 Ваш вклад поможет разработчикам во всём мире лучше использовать AI-инструменты!

Хотите, чтобы у вашего проекта тоже был качественный учебник? Всего 3 шага!

Шаг 1: Отправка Issue

1. Посетите GitHub Issues
2. Нажмите "New Issue"
3. Используйте следующий шаблон:

**Название проекта**: [Название проекта]
**Репозиторий GitHub**: https://github.com/[owner]/[repo]
**Описание проекта**: [1-2 предложения о назначении проекта]
**Целевая аудитория**: [Новичок/Продвинутый/Эксперт/Все]
**Язык учебника**: [Китайский/Английский/Другой]
**Примечания**: [Дополнительная информация]

Шаг 2: Проверка командой

• Мы рассмотрим вашу заявку в течение 1-3 рабочих дней
• Оценим, подходит ли проект для включения
• Проверим качество исходного кода и активность проекта

Шаг 3: Публикация учебника

• После проверки мы автоматически создаём учебник
• Проверяем работоспособность каждого шага
• Публикуем на официальном сайте, поддерживаем несколько языков

• Период проверки: 1-3 рабочих дня
• Генерация учебника: 3-7 рабочих дней
• Время публикации: Сразу после прохождения проверки

Q: Какие проекты подходят для включения? A: Открытые AI-инструменты, инструменты разработки, библиотеки, фреймворки и т. д. Должны обладать определённой технической глубиной и практической ценностью.

Q: Учебники бесплатные? A: Да, наши учебники полностью бесплатны и будут постоянно обновляться.

Q: Можно указать язык учебника? A: Да, мы поддерживаем 10 языков. Вы можете указать нужный язык в Issue.

🎯 Отправить заявку сейчас: Создать Issue →

MIT License

CC-BY-NC-SA 4.0

Attribution-NonCommercial-ShareAlike

✅ Вы можете:

• 📋 Делиться: Свободно делиться и адаптировать
• 🔧 Изменять: Создавать производные работы на основе содержания учебника
• 👥 Вносить вклад: Отправлять свои улучшения

❌ Вы не можете:

• 💰 Коммерческое использование: Без разрешения не использовать в коммерческих целях

💡 Если вы хотите использовать учебники в коммерческих целях, свяжитесь с нами: [email protected]

Есть вопросы или предложения? Свяжитесь с нами в любое время!

• 📧 Email: [email protected]
• 🐦 Twitter: @codingzys
• 💻 GitHub: vbgate/opencodedocs
• 📥 Отправить учебник: GitHub Issues
• 🌐 Официальный сайт: opencodedocs.com