1.6 KiB
Jak pracować nad tematem docs
[!NOTE] Szybkie przypomnienie, że nie musisz niczego skonfigurować do pracy nad zawartością strony dokumentacji.
Aby pracować nad wytycznymi dotyczącymi wkładu, możesz edytować lub dodawać pliki w katalogu
docs
dostępnym tutaj. Kiedy Twoje zmiany zostaną scalone, zostaną one udostępnione automatycznie na stronie dokumentacji.
Struktura strony internetowej dokumentów
Witryna jest generowana za pomocą docsify
i obsługiwana za pomocą stron GitHub.
Zazwyczaj nie musisz zmieniać żadnej konfiguracji ani budować witryny lokalnie. Jeśli jesteś zainteresowany, oto jak to działa:
- Źródło strony głównej dla tej witryny jest dostępne w
docs/index.html
. - Obsługujemy ten plik jako SPA używając
docsify
i GitHub Stron. - Skrypt
docsify
generuje zawartość plikówmarkdown
w katalogudocs
na żądanie. - Strona główna jest generowana z
_coverpage.md
. - nawigacja na pasku bocznym jest generowana z
_sidebar.md
.
Obsługa witryny dokumentacji lokalnie
Klonuj darmowy kod:
git clone https://github.com/freeCodeCamp/freeCodeCamp.git
docsify serve docs
Zainstaluj docsify
:
npm install -g docsify
i podaj katalog /docs
docsify służy dokumentom
Alternatywnie, jeśli zainstalowałeś freeCodeCamp lokalnie (zobacz lokalny przewodnik konfiguracyjny), łączymy CLI z narzędziami programistycznymi, dzięki czemu możesz uruchomić npm run docs:serve
z katalogu głównego repozytorium.