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

user types in margins

Browse source
This commit is contained in:
Tom van Woudenberg 2025-04-01 15:00:43 +02:00
parent 748f68d6d9
commit ae4f209be2
34 changed files with 141 additions and 102 deletions
Download patch file Download diff file Expand all files Collapse all files

6
book/basic-features/hypothesis.md
View file

@ -1,11 +1,13 @@
# Making comments on the website: Hypothesis
````{margin}
```{admonition} User types
:class: tip
This section is useful for user type 1-5.
```
{bdg-warning}`Javascript overlay` {bdg-success}`Chrome Extension`
````
# Making comments on the website: Hypothesis
Hypothesis is a third-party application that allows anyone to make publicly visible comments on a website (once you create a free account). This section explains how to use and install the extension. As this tool requires an account with a third-party, we advise to use our [local-annotator](../external/annotater/README.md) with similar capabilities but which store annotations locally. By default Hypothesis stores annotations publicly, which might confuse other students.

6
book/basic-features/overview.md
View file

@ -1,8 +1,10 @@
# Original Jupyter Book and Sphinx Features
````{margin}
```{admonition} User types
:class: tip
This section is useful for [user type 3-5](../installation-and-setup/user_types.md).
```
````
# Original Jupyter Book and Sphinx Features
These pages will provide a list of some common, basic book features which are all available in the original <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="../images/logo-wide.svg" alt="Jupyter book"></a> package. Additionally, this page includes also best-practices.

6
book/basic-features/utterances.md
View file

@ -1,11 +1,13 @@
# Discussions in your book: Utterances
````{margin}
```{admonition} User types
:class: tip
This section is useful for user type 3-5.
```
{bdg-white}`GitHub app and Javascript script`
````
# Discussions in your book: Utterances
[Utterances 🔮](https://utteranc.es/) is a lightweight open-source widget which allows you, your colleages and your students to discuss stuff in a blog post in your book. It is build on GitHub issues, so requires a GitHub repository, although the book can be hosted anywhere (so also on GitLab).