1.5 KiB
Miten työskennellä docs teema
[!HUOM] Nopea muistutus siitä, että sinun ei tarvitse asettaa mitään sisällön työstämiseen dokumentaatiosivustolle.
Voit muokata tai lisätä tiedostoja
docs-hakemistoon jotka ovat saatavilla tästä. Kun muutoksesi on yhdistetty, se asetetaan saataville automaattisesti dokumentaatiosivustolla.
Dokumenttien verkkosivuston rakenne
Sivusto luodaan käyttäen docsify, ja se tarjoillaan GitHub sivuilla.
Tyypillisesti sinun ei tarvitse muuttaa mitään konfiguraatiota tai rakentaa sivuston paikallisesti. Jos olet kiinnostunut, tässä on miten se toimii:
- Kotisivun lähde tälle sivustolle on saatavilla
docs/index.html. - Palvelemme tätä tiedostoa SPA:na käyttäen
docsifyja GitHub sivuja. - The
docsifyskripti generoimarkdowntiedoston sisällöndocshakemistoon pyynnöstä. - Kotisivu on luotu
_coverpage.md. - sivupalkin navigointi on luotu
_sidebar.md.
Asiakirjojen tarjoaminen paikallisesti
Monista freeCodeCamp:
git clone https://github.com/freeCodeCamp/freeCodeCamp.git
docsify serve docs
Asenna docsify:
npm install -g docsify
ja palvella /docs hakemistoa
docsify palvele dokumentteja
Vaihtoehtoisesti, jos olet asentanut freeCodeCamp paikallisesti (katso paikallinen asennusohje), me niputamme CLI kanssa kehitystyökaluja, jotta voit ajaa npm ajaa docs:serve juuresta repo.