Customization

The customization is done in the source/config.py file.

Practical Example

The source/config.py file used to build this web-content can be found here.

Repository Information

First, you need to make sure that the web-content correctly points to your own repository. To do so you will need to set:

• repository_owner: Your username or name of the organization your repository belongs to.

• repository_name: The actual name of your repository

• repository_branch: The branch you are deploying from. If unsure simply set this to main.

Custom 🦆Logo🦆

In order to add your own logo (ideally a file in the SVG format) you can add a file with the logo under source/_static and specify the path in the course_logo dictionary. Say you added the files my_logo_light.svg and my_logo_dark.svg under ./source/_static, then a valid configuration would look like this:

alt-text

Simply leave the alt-text empty ("alt-text" = "") to avoid showing to avoid showing some text under (or instead of) the logo.

# ./source/config.py
course_logo = {
    "image_light": "_static/my_logo_light.svg",
    "image_dark": "_static/my_logo_dark.svg",
    "alt-text": "MyLogo",
    "favicon": "_static/my_logo_light.svg",
}

Course Information

Finally, you need to set some project specific information, that is the name of your project, as well as, authorship and copyright informaiton.

The project name must be set with the setting project and will only set the title tag in the HTML header. In case this does not speak to you at all, simply set the project setting to the actual name of your web-course, e.g.:

project = 'My Intro To 🌐 Dominance'

Authorship information needs to be provided as an unstructured string with the author setting. We recommend to provide a comma separated list of full names along with a link to further information about the person (e.g. email or link to GitHub profile), e.g.:

author = 'Jon Doe - jon@doe.com, Marvin a depressed Android - github.com/marvin-android'

The copyright notice can be adapted if needed, it should contain at least the name of a natural or legal person. If you leave the copyright setting unchanged, it will show the current year and the repository owner. To write a custom copyright message use:

Note

We recommend to leave the copyright setting unchanged.

copyright = '1979, Jon Doe'