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
Install & authenticate required software
Collaborative book-editing
Organize editing team, collaboration and visibility
Choose URLs and tools
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
Types of H5p Quizzes
Live Code (Sphinx Thebe)
Programming assignment
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
Contact

Repository
Open issue

Search

Ctrl+K

By TeachBooks Team, built with TeachBooks and Jupyter Book, CC BY 4.0

Last updated on January 17, 2025.