Skip to content

TUD-JB-OS/starterkit

Repository files navigation

numbering
headings

README

This is the TU Delft starterkit for open publishing with Jupyter Book. It provides a skeleton with basic settings to have a head start with your thesis / project.

It includes:

  • a github deploy file taking care of deploying the website and building a pdf
  • basic content files that can be altered to fit your project
  • yml files in the root folder to configure the book and the pdf build

🕵 Where to start

Already know about Jupyter Book, familiar with GitHub or GitLab, Markdown... start with cloning the starterkit and start writing working on your project. New to the ecosystem? Start with the manual, and then move on to the starterkit.

🏁 Purpose

The purpose of this project and this manual is to enable others to use Jupyter Book for writing and publishing their own scientific and educational content. We hope to lower the technical barrier for researchers and educators to create and share their own resources, and to promote open science and open education practices.

📄 License

This book is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License, unless stated otherwise.

You are free to:

  • Share — copy and redistribute the material in any medium or format

  • Adapt — remix, transform, and build upon the material for any non-commercial purpose provided proper attribution is given.

❌ Errors

If you find any errors in the content, please report them by opening an issue on the GitHub repository.

💰 Funding

This project has received funding from the Delft University of Technology Open Science Fund (2025-2026).

⭐ Identifier

TUDJBOSSTARTERKIT

About

A Jupyter-Book starterkit for TU Delft bsc. and msc. thesis

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors