HelpFIT
Go to navigation

Configuration File

This page covers the basic configuration of a course using the course-pages.yml file. For a complete description, see the documentation on GitLab: course-pages.yml(5).

Configuration Options

Course Code

The main course code. This code is displayed in the page header and is used in the website URL (e.g., https://courses.fit.cvut.cz/BI-MLO/).

course:
  code: BI-MLO

Course Name

The full name of the course in the language specified in the configuration option language. This name appears in the page header.

course:
  name: Mathematical Logic

Language

Specifies the language of the pages and should match the language in which the content is written. You can choose: cs (default) or en.

language: cs

GitLab Repository

The path to the course repository at https://gitlab.fit.cvut.cz/, where the source files for the generated website are located. For the course BI-MLO, which has its source files stored at https://gitlab.fit.cvut.cz/BI-MLO/bi-mlo, the path would look like this:

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

Pages can be hidden by defining the navigation.hiddenFiles attribute.

navigation:
  hiddenFiles:
    - images/ 1
    - others/*.txt 2
    - "*.jpg" 3
  1. Hides the entire images directory.
  2. Hides all .txt files in the others directory.
  3. Hides all .jpg files.

Required parameters

The following parameters in course-pages.yml are required:

  • course.code
  • course.name
  • repository.gitlabPath or repository.webUrl (described in the documentation)

Example of the course-pages.yml file:

course:
  code: BI-MLO
  name: Mathematical Logic
language: cs
repository:
  gitlabPath: /BI-MLO/bi-mlo