Návody FIT
Jdi na navigaci

Konfigurační soubor

Tato stránka se věnuje základní konfiguraci předmětu s pomocí souboru course-pages.yml. Úplný popis naleznete v dokumentaci na GitLab course-pages.yml(5).

Konfigurační možnosti

Kód kurzu

Hlavní kód kurzu. Tento kód se zobrazuje v záhlaví stránky a používá se v adrese URL webu (Např. https://courses.fit.cvut.cz/BI-MLO/).

course:
  code: BI-MLO

Název kurzu

Úplný název kurzu v jazyce, který je uveden v konfigurační možnosti language. Tento název se zobrazí v záhlaví stránky.

course:
  name: Matematická logika

Jazyk

Určuje jazyk stránek a měl by odpovídat jazyku, ve kterém je napsán obsah. Můžete si vybrat: cs (výchozí hodnota) nebo en.

language: cs

Repozitář na GitLabu

Cesta k úložišti kurzu na adrese https://gitlab.fit.cvut.cz, kde jsou umístěny zdrojové soubory generovaného webu. Pro předmět BI-MLO, který má zdrojové soubory uloženy na adrese https://gitlab.fit.cvut.cz/BI-MLO/bi-mlo, by cesta vypadala takto:

repository:
  gitlabPath: /BI-MLO/bi-mlo

Stránky lze skrýt zadefinováním atributu navigation.hiddenFiles.

...
navigation:
  hiddenFiles:
    - images/ 1
    - others/*.txt 2
    - "*.jpg" 3
  1. Skryje celý adresář images.
  2. Skryje všechny .txt soubory v adresáři others.
  3. Skryje všechny .jpg soubory`.

Požadované parametry

Následující parametry v course-pages.yml jsou povinné:

  • course.code
  • course.name
  • repository.gitlabPath nebo repository.webUrl (popsáno v dokumentaci)

Příklad souboru course-pages.yml:

course:
  code: BI-MLO
  name: Matematická logika
language: cs
repository:
  gitlabPath: /BI-MLO/bi-mlo