Dodawanie nieoficjalnych bibliotek
Wytyczne dotyczące zgłaszania nieoficjalnych bibliotek
- Zgłoszenia muszą być napisane w języku angielskim.
- Właściciel biblioteki musi dołączyć do naszego serwera Discord
- Biblioteki muszą odpowiadać dobrym praktykom jakości kodu.
- Biblioteki nie mogą zawierać złośliwego oprogramowania ani innych niebezpiecznych zachowań.
- Biblioteka musi być publicznie dostępna i aktywnie utrzymywana.
- Zapewnij jasne instrukcje instalacji i użycia w swoim repozytorium.
Zastrzegamy sobie prawo do:
- Modyfikowania Twojego zgłoszenia po przeglądzie.
- Usunięcia Twojego zgłoszenia, jeśli stanie się nieaktualne, niebezpieczne lub przestało być utrzymywane.
Dodawanie nowej nieoficjalnej biblioteki
1. Sforkuj to repozytorium
2. Sklonuj swój fork i przejdź (cd) do katalogu projektu
3. Zainstaluj VitePress
Wymagania wstępne VitePress znajdziesz w oficjalnej dokumentacji.
sh
npm add -D vitepress@nextsh
pnpm add -D vitepress@nextsh
yarn add -D vitepress@next vuesh
bun add -D vitepress@next4. Dodaj swoją nieoficjalną bibliotekę do paska bocznego
- Otwórz
/docs/.vitepress/config.mts. - Znajdź sekcję "Nieoficjalne biblioteki" w pasku bocznym.
- Dodaj link do repozytorium Twojej biblioteki.
- Zachowaj kolejność alfabetyczną listy według nazw języków programowania.
5. Uruchom serwer deweloperski
Przed utworzeniem pull requesta zweryfikuj lokalnie, czy Twoje zmiany niczego nie zepsuły.
sh
npm run devsh
pnpm run devsh
yarn devsh
bun run dev6. Utwórz Pull Request
Prześlij pull request do oryginalnego repozytorium.