Hyppää sisältöön

Guides osan opas

Missä on 2021 guides?

Guides löytyy wimmalab2021-nextjs. Tänä vuonna ei tehty kokonaan uutta Black Bookia, mutta sen englanninkäännöstä parannettiin, ja Mysticons teki uuden Green Bookin sisältäen enemmän tarpeellista tietoa kenelle tahansa.

Missä on vanhemmat guidesit?

WIMMA Lab ryhmän repossa guides-and-info.

Miten Guidesiin lisätään uusia Guideseja?

Kaikki guidesit löytyy kansiosta guides. Kun lisäät sinne kansion guidesin nimellä, jossa on kaikki kappaleet [Chapter_Number]-[Chapter_Name].mdx muodossa, ja etusivu muodossa index.mdx, pitäis sivustojen generoida ne itsestään.

Tarkemmat Requirements

  • Kaikki kuvat pitää laittaa public/assets/[guide_name] kansioon, ja niitä voi referoida tällä tavalla:

    /assets/guide_images/image005.jpg

  • Kappaleet pitää olla muodossa [Chapter_Number]-[Chapter_Name].mdx, koska jos ne eivät ole, navigaatio ei toimi. Koodissa sortataan kaikki järjestykseen, joten ne menevät numerojärjestyksessä. Esimerkkinä:

    guides/Black-Book-fi/01-Johdanto.mdx

  • Guide tarvitsee index.mdx tiedoston, josta generöidään ensimmäinen sivu guidesille, ja voit kertoa lyhyesti mistä tämä guides kertoo ja miksi se tehtiin. Index.mdx tiedosto sijoitetaan samaan kansioon kuin muut guiden kappaleet:

    guides/Black-Book-fi/index.mdx

  • Index.mdx tarvitsee myös frontmatteria /guides/ sivun generointiin. Sitä tarvitsee seuraavat:
  • title
  • description
  • image, where the front cover picture is of the guide
  • Ennen frontmatteria ja sen jälkeen mdx tarvitsee ----. Frontmatter example

  • Jos mdx:ssä on koodia mitä haluat highlightata, laita ekana se neljän ```` väliin, jonka ensimmäisen jälkeen kirjaa mikä kieli on minkä haluat highlightata:

    Koodiblokkiesimerkki