Dodawanie nowych przykładów kodu
Wytyczne dotyczące zgłaszania przykładów kodu
- Zgłoszenia muszą być napisane w języku angielskim.
- Udokumentuj swój przykład tak szczegółowo, jak to możliwe.
- Upewnij się, że Twój kod działa i został dokładnie przetestowany.
Zastrzegamy sobie prawo do:
- Modyfikowania Twojego zgłoszenia po jego przesłaniu.
- Usunięcia Twojego zgłoszenia, jeśli okaże się to konieczne.
Tworzenie nowego przykładu kodu
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 swój przykład kodu
4.1 Utwórz plik przykładu
- Utwórz nowy plik w
/docs/exampleso nazwie pochodzącej od języka programowania. - Nazwa pliku musi kończyć się rozszerzeniem
.md. - Dołącz co najmniej dwa różne sposoby wykonywania zapytań do API.
4.2 Dodaj przykład do paska bocznego
- Otwórz
/docs/.vitepress/config.mts. - Znajdź sekcję "Przykłady kodu" w pasku bocznym.
- Dodaj swój nowy plik do listy.
- 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.