Добавление новых примеров кода

Руководство по добавлению примеров кода

• Материалы должны быть написаны на английском языке.
• Задокументируйте ваш пример как можно подробнее.
• Убедитесь, что ваш код работает и был должным образом протестирован.

Мы оставляем за собой право:

• Изменять ваш материал после его отправки.
• Удалить ваш материал в случае необходимости.

Создание нового примера кода

1. Сделайте форк (Fork) этого репозитория

2. Клонируйте ваш форк и перейдите в директорию проекта (cd)

3. Установите VitePress

Предварительные требования для установки VitePress можно найти в официальной документации.

npm

npm add -D vitepress@next

pnpm

pnpm add -D vitepress@next

yarn

yarn add -D vitepress@next vue

bun

bun add -D vitepress@next

---

4. Добавьте ваш пример кода

4.1 Создайте файл примера

1. Создайте новый файл в /docs/examples, названный в честь языка программирования.
2. Имя файла должно оканчиваться на .md.
3. Включите как минимум два различных способа выполнения API-запросов.

4.2 Добавьте пример в боковое меню (sidebar)

1. Откройте /docs/.vitepress/config.mts.
2. Найдите раздел "Code Examples" в боковом меню.
3. Добавьте ваш новый файл в список.
4. Сохраняйте алфавитный порядок списка по названию языка программирования.

---

5. Запустите сервер разработки

Перед созданием pull request убедитесь локально, что ваши изменения ничего не нарушили.

npm

npm run dev

pnpm

pnpm run dev

yarn

yarn dev

bun

bun run dev

---

6. Создайте Pull Request

Отправьте pull request в оригинальный репозиторий.