admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

edited_overview

Browse source
This commit is contained in:
Isabel Slingerland 2024-03-03 17:13:04 +01:00
parent 7667163bf8
commit f3cf6688e6
7 changed files with 29 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
book/examples/h5p_examples.md
View file

@ -1,4 +1,4 @@
# Examples H5p
# H5p
This page shows some examples of H5p questions.

11
book/examples/overview.md
View file

@ -1,3 +1,12 @@
# Overview
This part will include examples for jupyter book pages with features
This chapter includes examples for jupyter book pages with features. Here is an overview of the different examples:
- H5p: examples of H5p questions
- Combining theory with interactive questions
- Templates for interactive coding / non-coding elements:
- Programming assignment: Example of how to convert a Jupyter notebook to Jupyter Book with live coding
- Combining theory with interactive questions and extensive coding assignment: Example how to combine theory, quizzes and code on one page
- Combining theory with interactive questions: Example how to combine theory with questions, so there's no coding involved.
- Parametric question: Example for an equation to be checked on equivalence with the correct answer

2
book/features/grasple.md
View file

@ -1,4 +1,4 @@
# Embedding Grasple question
# Grasple questions
[Grasple](https://app.grasple.com/) gives you an embed code for each exercise which looks like this, which can be added cirectly to your markdown-file.
```html

2
book/features/jupyterlite/including-jupyterlite.md
View file

@ -1,4 +1,4 @@
# Adding `JupyterLite` to a page
# How to add `JupyterLite` to a page
There are three different `JupyterLite` directives that you can include in your web page:

2
book/features/jupyterlite/jupyterlite.md
View file

@ -1,4 +1,4 @@
# Interactive elements with JupyterLite-Sphinx
# JupyterLite-Sphinx: Interactive elements
By popular demand: how to include interactive pieces of code in your Jupyter Book. We can do this by using the [JupyterLite](https://github.com/jupyterlite) app, which allows you to run a Jupyter Lab session and execute Python code entirely in-browser. Jupyterlite can be embedded in a Jupyter Book with the [`JupyterLite-Sphinx`](https://github.com/jupyterlite/jupyterlite-sphinx) extension.

19
book/features/overview.md
View file

@ -1,14 +1,25 @@
# CEG-book Features
```{warning} Under Construction!
This page will provide a list of some commonly used book features, and sub-pages will provide additional information, specifically:
This chapter provides a list of commonly used book features together with sub-pages that provide additional information on:
- the purpose
- how to install them
- how to use them
- 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
- 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
- Exclude parts of book from published book
- Page download options
To see examples for these features, go to the Example chapter.
The {guilabel}`books-CEG` label indicates a feature developed by us.

4
book/features/remove_from_publish.md
View file

@ -1,4 +0,0 @@
(remove_from_publish)=
# Remove From Publish
Describe me.