diff --git a/book/examples/h5p_examples.md b/book/examples/h5p_examples.md index 5c75bfc..9fddae4 100644 --- a/book/examples/h5p_examples.md +++ b/book/examples/h5p_examples.md @@ -1,4 +1,4 @@ -# Examples H5p +# H5p This page shows some examples of H5p questions. diff --git a/book/examples/overview.md b/book/examples/overview.md index 7de0ba3..baf8847 100644 --- a/book/examples/overview.md +++ b/book/examples/overview.md @@ -1,3 +1,12 @@ # Overview -This part will include examples for jupyter book pages with features \ No newline at end of file +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 + diff --git a/book/features/grasple.md b/book/features/grasple.md index 59102ac..6cb2359 100644 --- a/book/features/grasple.md +++ b/book/features/grasple.md @@ -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 diff --git a/book/features/jupyterlite/including-jupyterlite.md b/book/features/jupyterlite/including-jupyterlite.md index 6e3f569..f462822 100644 --- a/book/features/jupyterlite/including-jupyterlite.md +++ b/book/features/jupyterlite/including-jupyterlite.md @@ -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: diff --git a/book/features/jupyterlite/jupyterlite.md b/book/features/jupyterlite/jupyterlite.md index c26432d..6ac2e11 100644 --- a/book/features/jupyterlite/jupyterlite.md +++ b/book/features/jupyterlite/jupyterlite.md @@ -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. diff --git a/book/features/overview.md b/book/features/overview.md index 51fb44a..66cb316 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -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. diff --git a/book/features/remove_from_publish.md b/book/features/remove_from_publish.md deleted file mode 100644 index 71f6bf5..0000000 --- a/book/features/remove_from_publish.md +++ /dev/null @@ -1,4 +0,0 @@ -(remove_from_publish)= -# Remove From Publish - -Describe me. \ No newline at end of file