Skip to main content
Ctrl+K
TeachBooks Manual - Home TeachBooks Manual - Home

Getting started!

  • User types
  • Collaboration tool: Git
  • 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
  • Your first TeachBook using the GitHub template
  • 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
  • Choose URLs and tools
  • Before doing any content: copyright

Features

  • Original Jupyter Book Features
    • Anatomy of a Jupyter Book
    • Figures
    • Equations
    • Videos
    • References
    • Code
    • Code blocks that produce figures
    • Banner or Announcement
    • Making comments on the website: Hypothesis
    • Discussions in your book: Utterances
  • TeachBooks Authoring Features
    • TeachBooks Package: Jupyter-Book Wrapper for Pre- and Postprocessing
    • GitHub reusable action: publish your book online to GitHub Pages
    • Git workflow: Share content between books
    • Sphinx extension: Download link replacer
    • Sphinx extension: Image Inverter
    • Sphinx extension: JupyterBook-Patches
    • Sphinx extension: TU Delft theme
    • Interactive content: Elements not including Python
      • Sphinx extension: Grapsle
      • Adding interactive h5p elements
      • 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

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
    • LaTeX to Markdown conversion
    • Snippit
    • Extensionchecker, filedownloader and figreturner
    • Figshrinker
  • Repository
  • Open issue

Index

T

T

  • Truss structures

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

Last updated on November 19, 2024.