Skip to main content

Ctrl+K

Manual

Your First TeachBook!

What is a TeachBook?
How can you do it?
It only takes 10 clicks!
You Know the Basics: What Next?

Getting Going!

User types
Collaboration tool: Git
- Which git provider to choose
Install & authenticate required software
Collaborative book-editing
Organize editing team, collaboration and visibility
Versioning and URLs
Copyright and Licenses checklist

Features

Overview
Original Jupyter Book and Sphinx Features
Easy Editing Process
Additional functionality
Book styling
TeachBooks Student-view Features
- Local Annotator Extension
- Making comments on the website: Hypothesis

Examples

TeachBooks Examples
Well-Structured Book
Live Code (Sphinx Thebe)
Programming assignment with checks
Combining theory & interactive quizzes
Theory, interactive quizzes & live code
Coding theory, interactive quizzes & live code
Parametric questions

Editing Tools

Figure syntax maker
Scripts for automating workflow

Miscallaneous

References
Credits and License
Changelog
Contact

Repository
Open issue

Search

Ctrl+K

By TeachBooks Development Team and TeachBooks users, built with TeachBooks, CC BY 4.0

Last updated on June 1, 2025.