The instructions on this page guide you through the process of setting up your own thesis (repo) by creating a (new) GitHub repository using the starterkit template repository.
Create your own project online¶
We assume you have a GitHub account and are logged in. If not, please create an account and log in first. Follow these instruction to use the GitHub template repository to create your own thesis repository:
1. Create your own repository¶
Go to the use the starterkit template
Choose a proper name of your repository (this will be also part of your URL!) and leave visibility as
public.Click the green
Create repositorybutton, this will start copying all files to your newly created repository.
Figure 1:Follow these steps to create your own repository from the template.
2. Launch your website¶
You were directed to the main page of your repository, all files have been copied but the settings were not.
Click on
and in the left menu on 
and change source: Deploy from a branchtosource: Github ActionsClick on
in the top left corner and click on ⚙ (the gear-iconnear About) at the right site of the page.Check the box Use your GitHub Pages website.
Go to
in the top menu, click on (red) initial commitand clickre-run all jobs
The book will now be deployed again - where now it can actually load GitHub pages! You are all set and done.
Work locally¶
You can work directly in the GitHub IDE, but you may prefer to work on the project locally. To do this, you will need Git and Pixi. Pixi is a package manager that installs and manages all dependencies required for the project.
Install git: If Git is not already installed on your computer, download and install it from the git website.
Install pixi: Download and install Pixi by following the instructions in the pixi documentation.
Clone the repository: Open a terminal, such as the VS Code terminal, PowerShell, or another terminal of your choice. Navigate to the folder where you want to store the project and run:
git clone <repository-link>This creates a local copy of the repository on your computer. Next, navigate into the newly created project folder:cd <project-folder>Install the project dependencies From inside the project folder, run:
pixi installPixi will install all dependencies required to work on the project.
Three Pixi tasks are provided to make working with the project easier. You can run the following commands in the terminal:
Open the editor:
pixi run editorwill open jupyterlab as editorPreview the Jupyter Book:
pixi run previewwill open a jupyter server which runs your jupyter book as website in the browserCreate a PDF:
pixi run pdfwill create a pdf version of your project