manual

Book describing how to use interactive textbooks, our extensions and our workflow: teachbooks.github.io/manual (release branch).

https://github.com/teachbooks/manual

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Book describing how to use interactive textbooks, our extensions and our workflow: teachbooks.github.io/manual (release branch).

Basic Info
  • Host: GitHub
  • Owner: TeachBooks
  • License: other
  • Language: Jupyter Notebook
  • Default Branch: release
  • Homepage: https://teachbooks.io/manual/
  • Size: 30.3 MB
Statistics
  • Stars: 5
  • Watchers: 2
  • Forks: 7
  • Open Issues: 26
  • Releases: 5
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme License Citation Codeowners

README.md

TeachBooks Manual

DOI call-deploy-book

This manual assists you in creating and collaborating on JupyterBooks for educational purposes. Some parts are specifically aimed for teachers at Delft University of Technology, although all material and tools are openly available. This manual aims at providing an easy start and advanced usages for new and existing users with or without skills on this topic. it is part of TeachBooks, for more information visit https://teachbooks.io/.

Contact

If you encounter any issues and you have a TU Delft account, report it by clicking the github icon and lightbulb on the top right corner of this page. Or contribute directly by creating a merge request in the repository.

If you have questions, contact the TeachBooks Development Team at info@teackbooks.io, also for non-TU Delft account holders. You can also contact us in our GitHub discussions

We really value your feedback on this manual. This helps us improving it. Please keep using the manual as you build your own Jupyter Book and come back to fill out this short survey.

Contribute

This book will continue to develop, so feel free to contribute https://github.com/TeachBooks/manual! You can do so directly by forking this repository and creating a merge request.

The released book can be found on on https://teachbooks.io/manual. This page shows the built book of the release branch All branches will also be visible as seen in the action's summaries: https://github.com/TeachBooks/mirrorteachbookmanual/actions

Some parts of this book are taken from other sources in the form of submodules (linked in the folder book/external). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this book including its submodules, clone using: git clone --recurse-submodules git@github.com:TeachBooks/manual.git

Happy book building!

Owner

  • Name: PSOR Books
  • Login: TeachBooks
  • Kind: organization
  • Email: books-CEG@tudelft.nl
  • Location: Netherlands

Teachers’ Educational Assistance for interaCtive Hands-on Browser-based Online Open Knowledge for Students

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
message: 'If you use this Book, please cite it using these metadata.'
authors:
  - email: info@teachbooks.io
    name: 'TeachBooks Development Team'
    website: 'https://teachbooks.io/'
title: 'TeachBooks Manual source code'
preferred-citation:
  type: book
  authors:
  - email: info@teachbooks.io
    name: 'TeachBooks Development Team'
    website: 'https://teachbooks.io/'
  url: 'https://doi.org/10.5281/zenodo.15100847' 
  identifiers:
    - type: doi
      value: 10.5281/zenodo.15100848
      description: Zenodo record
    - type: url
      value: 'https://teachbooks.io/manual/'
      description: 'Published book on GitHub Pages'
    - type: url
      value: 'https://github.com/TeachBooks/manual'
      description: 'GitHub repository'
  abstract: >-
    his manual assists you in creating and collaborating on JupyterBooks
    for educational purposes. Some parts are specifically aimed for
    teachers at Delft University of Technology, although all material and
    tools are openly available. This manual aims at providing an easy start
    and advanced usages for new and existing users with or without skills
    on this topic. 
  keywords:
    - TeachBooks
    - Manual
    - 'Jupyter Book'
  title: 'TeachBooks Manual'
  institution:
    name: 'TeachBooks'
  license: CC-BY-4.0
  license-url: 'https://creativecommons.org/licenses/by/4.0/'
  copyright: '© 2025 TeachBooks'
  version: v1.2.1
  date-released: '2025-03-28'
  languages:
    - en
  contact:
  - email: info@teachbooks.io
    name: 'TeachBooks Development Team'

GitHub Events

Total
  • Create event: 143
  • Release event: 2
  • Issues event: 73
  • Watch event: 5
  • Delete event: 133
  • Issue comment event: 140
  • Member event: 3
  • Push event: 574
  • Pull request review comment event: 47
  • Pull request review event: 83
  • Pull request event: 251
  • Fork event: 9
Last Year
  • Create event: 143
  • Release event: 2
  • Issues event: 73
  • Watch event: 5
  • Delete event: 133
  • Issue comment event: 140
  • Member event: 3
  • Push event: 574
  • Pull request review comment event: 47
  • Pull request review event: 83
  • Pull request event: 251
  • Fork event: 9

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 14
  • Total pull requests: 106
  • Average time to close issues: 16 days
  • Average time to close pull requests: 1 day
  • Total issue authors: 5
  • Total pull request authors: 6
  • Average comments per issue: 1.14
  • Average comments per pull request: 0.36
  • Merged pull requests: 80
  • Bot issues: 1
  • Bot pull requests: 78
Past Year
  • Issues: 14
  • Pull requests: 106
  • Average time to close issues: 16 days
  • Average time to close pull requests: 1 day
  • Issue authors: 5
  • Pull request authors: 6
  • Average comments per issue: 1.14
  • Average comments per pull request: 0.36
  • Merged pull requests: 80
  • Bot issues: 1
  • Bot pull requests: 78
Top Authors
Issue Authors
  • Tom-van-Woudenberg (19)
  • rlanzafame (12)
  • guin0x (9)
  • FreekPols (3)
  • utterances-bot (1)
  • SandraVerhagen (1)
  • xtinamark (1)
  • xjulie0x (1)
Pull Request Authors
  • dependabot[bot] (83)
  • Tom-van-Woudenberg (25)
  • rlanzafame (16)
  • douden (2)
  • xjulie0x (2)
  • sanderrenes (1)
  • guin0x (1)
  • rivereh (1)
Top Labels
Issue Labels
enhancement (4) good first issue (2) documentation (1) waiting (1) bug (1)
Pull Request Labels
dependencies (83) submodules (45) python (25) documentation (2) enhancement (2)

Dependencies

.github/workflows/call-deploy-book.yml actions
requirements.txt pypi
  • download_link_replacer *
  • jupyter-book *
  • jupyterbook_patches *
  • jupyterlite-sphinx *
  • sphinx-inline-tabs *
  • sphinx-thebe *
  • teachbooks *
book/_ext/pybtexapastyle/setup.py pypi