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
    • Editing text: VS Code
    • Git: GitHub Desktop / Git in VS Code
    • Managing code-related software: Anaconda
    • Combining Git Bash, VS Code and Conda
    • Build your book: JupyterBook
  • Collaborative book-editing
    • Assign task to yourself (milestones, issues)
    • Create your own version (branching, cloning, pulling)
    • Edit (merge conflicts, staging, committing, pushing)
    • Check changes online
    • Reviewing and combine versions (merge/pull request, merging)
  • Organize editing team, collaboration and visibility
  • Versioning and URLs
    • Publish version on separate (fixed) URLs
    • TeachBooks versioning with changelog
    • Publishing your book with a publisher
  • Copyright and Licenses checklist
    • Copyright Considerations
    • Licenses
    • Recommendations

Features

  • Overview
  • Original Jupyter Book and Sphinx Features
    • Anatomy of a Jupyter Book
    • Figures
    • Equations
    • Videos
    • References
    • Code
    • Code blocks that produce figures
    • Badges, Buttons & Icons
    • Banner or Announcement
  • Easy Editing Process
    • TeachBooks template
    • Draft-Release Workflow
    • Releasing book online
    • Build pull requests from forks
    • Local Server to view interactive elements locally
    • Sharing content between books in table of contents
      • (Deprecated) Share content between books using submodules
    • Auto-updating packages
    • TeachBooks Versioning
  • Additional functionality
    • Download link replacer
    • Multilingual book
    • Discussions in your book: Utterances
    • H5p interactive elements
      • Examples of H5p Quizzes
    • Interactive plots: plotly
    • Grasple
    • Interactive HTML/JavaScript elements
      • Adding interactive HTML/JavaScript elements
      • Creating basic interactive HTML/JavaScript elements
    • Interactive content: Run Python inside your book
      • Ipywidgets
      • Exercise checking using check-answer button
    • JupyterQuiz
    • Iframes
    • PRIME applets
  • Book styling
    • Image Inverter
    • JupyterBook-Patches
    • TU Delft theme
    • Rich hover over tips
    • APA References
    • Custom named colors
  • 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
    • Convert LaTeX to Markdown
    • Move images to separate hosting
    • Snippit
    • Extensionchecker, filedownloader and figreturner
    • Figshrinker

Miscallaneous

  • References
  • Credits and License
  • Changelog
  • Contact
  • Repository
  • Open issue

Index

T

T

  • Truss structures

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

Last updated on April 1, 2025.