Добавление неофициальных библиотек

Руководство по добавлению неофициальных библиотек

• Материалы должны быть написаны на английском языке.
• Владелец библиотеки должен присоединиться к нашему Discord-серверу
• Библиотеки должны соответствовать хорошим практикам качества кода.
• Библиотеки не должны содержать вредоносное ПО или иное небезопасное поведение.
• Библиотека должна быть общедоступной и активно поддерживаться.
• Предоставьте четкие инструкции по установке и использованию в вашем репозитории.

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

• Изменять ваш материал после рассмотрения.
• Удалить ваш материал, если он устарел, небезопасен или больше не поддерживается.

Добавление новой неофициальной библиотеки

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. Добавьте вашу неофициальную библиотеку в боковое меню

1. Откройте /docs/.vitepress/config.mts.
2. Найдите раздел "Unofficial Libraries" в боковом меню.
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 в оригинальный репозиторий.