Skip to content

Додавання нових прикладів коду

Правила внесення прикладів коду

  • Пояснення повинні бути написані англійською мовою.
  • Документуйте свій приклад якомога детальніше.
  • Переконайтеся, що ваш код працює та належним чином протестований.

Ми залишаємо за собою право:

  • Змінювати ваш матеріал після його надсилання.
  • Видалити ваш матеріал за потреби.

Створення нового прикладу коду

1. Зробіть форк цього репозиторію

2. Клонуйте свій форк та перейдіть у каталог проекту за допомогою cd

3. Встановіть VitePress

Ви можете знайти попередні вимоги VitePress в офіційній документації.

sh
npm add -D vitepress@next
sh
pnpm add -D vitepress@next
sh
yarn add -D vitepress@next vue
sh
bun add -D vitepress@next

4. Додайте свій приклад коду

4.1 Створіть файл прикладу

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

4.2 Додайте приклад до бічної панелі

  1. Відкрийте /docs/.vitepress/config.mts.
  2. Знайдіть розділ "Code Examples" у бічній панелі.
  3. Додайте свій новий файл до списку.
  4. Зберігайте список в алфавітному порядку за назвою мови програмування.

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

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

sh
npm run dev
sh
pnpm run dev
sh
yarn dev
sh
bun run dev

6. Створіть Pull Request

Надішліть pull request до оригінального репозиторію.