Vytvorenie dokumentácie

Postup, ako vytvoriť dokumentáciu s použitím Markdown nástroja MkDoc s auto-deployom na Gitlab Page:

  1. Vytvor nový repozitár (alebo forkni webnotion/wiki)
  2. V prípade vytvorenia čistého repozitára, nakopíruj obsah webnotion/wiki
  3. Uprav mkdocs.yml:
    • site_name
    • site_url - musí byť vo formáte: https://codename-group}.gitlab.io/codename-wiki-repo alebo alternatívne nakonfigurovať vlastnú url (v Settings / Pages) a nezabudnúť ju nastaviť aj sem (táto úprava trvá nejaký čas aj napriek success pipeline-u - cca 5-15 min - dovtedy bude vyhadzovať Error 404)
  4. V gitlab-ci.yml len prekontrolovať a prípadne upraviť/doplniť časť pages / script
  5. Pipeline by sa mal pri každom commite do master-u automaticky vykonať (nie je potrebné nič zapínať, iba mať yml súbor prítomný)
  6. Môžeš začať vytvárať nové časti dokumentácie (dá sa použiť aj jednoduché varianty HTML syntaxe)