mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-12 22:35:51 +00:00
Merge branch 'links' into 'main'
Links See merge request interactivetextbooks-citg/jupyter-book-manual!102
This commit is contained in:
commit
308ea10b34
4 changed files with 19 additions and 19 deletions
|
|
@ -36,11 +36,11 @@ parts:
|
|||
- file: basic-features/Code_block_figures
|
||||
- file: basic-features/banner
|
||||
title: Banner or Announcement
|
||||
- file: basic-features/hypothesis
|
||||
- file: basic-features/utterances
|
||||
- file: basic-features/hypothesis.md
|
||||
- file: basic-features/utterances.md
|
||||
- file: features/overview
|
||||
sections:
|
||||
- file: features/teachbooks
|
||||
- file: external/TeachBooks/README.md
|
||||
title: TeachBooks Package
|
||||
- file: external/deploy-book-workflow/README.md
|
||||
- file: features/remove_from_publish
|
||||
|
|
@ -68,7 +68,7 @@ parts:
|
|||
|
||||
- caption: Examples
|
||||
chapters:
|
||||
- file: examples/overview
|
||||
- file: examples/overview.md
|
||||
- file: examples/book_structure.md
|
||||
- file: examples/h5p_examples.md
|
||||
- file: examples/live_code.md
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ This section is useful for user type 3-5.
|
|||
```
|
||||
|
||||
## Instruction
|
||||
H5p elements are interactive HTML-blocks which can be imbeded in a Jupyter Book using an iframe. H5p element can be created in the [TU Delft portal on the H5p website](https://tudelft.h5p.com/content) (sign in via Brightspace to H5p required first). The iframe code can be copied at Edit - Publish - Public - Embed code. This html code can be directly added to your markdown file:
|
||||
H5p elements are interactive HTML-blocks which can be embedded in a Jupyter Book using an iframe. An H5p element can be created in the [TU Delft portal on the H5p website](https://tudelft.h5p.com/content) (sign in via Brightspace to H5p required first). The iframe code can be copied at Edit - Publish - Public - Embed code. This html code can be directly added to your markdown file:
|
||||
|
||||
```html
|
||||
<iframe src="https://tudelft.h5p.com/content/.../embed" aria-label="..." width="1088" height="200" frameborder="0" allowfullscreen="allowfullscreen" allow="autoplay *; geolocation *; microphone *; camera *; midi *; encrypted-media *"></iframe><script src="https://tudelft.h5p.com/js/h5p-resizer.js" charset="UTF-8"></script>
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@
|
|||
"sphinx-thebe ~= 0.9.9\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"This will download the correct version of the sphinx extension when the book is build on the server (which loads the required packages from `requirements.txt`)\n",
|
||||
"This will download the correct version of the sphinx extension when the book is built on the server (which loads the required packages from `requirements.txt`)\n",
|
||||
"\n",
|
||||
"If you want to build the book locally, you need to install this version of sphinx-thebe in your environment as well with:\n",
|
||||
"```\n",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# TeachBooks Features
|
||||
|
||||
We collect a suite of existing open-source software and keep our books up-to-date so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. By deploying these tools from a central location we can prevent common problems before they arise, and fix them quickly when they do occur. As the open-source software landscape changes rapidly, it is esential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching!
|
||||
As TeachBooks, we collect a suite of existing open-source software and keep our books up-to-date so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. By deploying these tools from a central location we can prevent common problems before they arise, and fix them quickly when they do occur. As the open-source software landscape changes rapidly, it is essential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching!
|
||||
|
||||
This chapter provides a list of commonly used book features together with sub-pages that provide additional information on:
|
||||
- the purpose
|
||||
|
|
@ -9,17 +9,17 @@ This chapter provides a list of commonly used book features together with sub-pa
|
|||
- where to find the source code
|
||||
|
||||
Overview of features covered:
|
||||
- Interaction on the website: Adding comments and feedback to content on the website
|
||||
- Grasple Questions: Explanation how to embed Grasple questions in the book.
|
||||
- Adding interactive h5p elements: Embedding interactive HTML-blocks in the book
|
||||
- Exclude parts of book from published book
|
||||
- Page download options
|
||||
- Python-enabled interactivity: Run Python code live in the browser
|
||||
- Widgets
|
||||
- Exercise checking using check-answer button
|
||||
- JupyterLite-Sphinx: Including interactive pieces of content in the book.
|
||||
- Configuration
|
||||
- How to add `JupyterLite` to a page
|
||||
- Interaction with the book: Adding comments and feedback to content on the website using [Hypothesis](/book/basic-features/hypothesis.md) or [Utterances 🔮](/book/basic-features/utterances.md)
|
||||
- [Grasple Questions](grasple.md): Embedding Grasple questions in your book
|
||||
- [H5p elements](h5p.md): Embedding interactive HTML-blocks in your book
|
||||
- [Exclude draft parts of the book from the published book](custom_toc.md)
|
||||
- [Page download options](custom_download.md)
|
||||
- [Python-enabled interactivity](live_code.ipynb): Run Python code live in the browser
|
||||
- [Widgets](widgets.ipynb)
|
||||
- [Exercise checking](exercise_checking.ipynb): Using the check-answer button
|
||||
- [JupyterLite-Sphinx](/book/features/jupyterlite/jupyterlite.md): Including interactive pieces of content in the book.
|
||||
- [Configuration](/book/features/jupyterlite/configuration.md)
|
||||
- [Adding `JupyterLite` to a page](/book/features/jupyterlite/including-jupyterlite.md)
|
||||
|
||||
To see examples for these features, go to the Example chapter.
|
||||
To see examples for these features, go to the [Examples chapter](/book/examples/overview.md).
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue