Document how to hide solutions

zeek · Jan 24, 2025 · 00511fa · 00511fa
1 parent c3c8ef9
commit 00511fa
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -5,6 +5,8 @@
 - [Why Spicy?](./why_spicy.md)
 - [Prerequisites](./prerequisites.md)
 
+---
+
 - [Spicy language](./language.md)
   - [Hello world](./hello_world.md)
   - [Basic types](./basic_types.md)

diff --git a/src/prerequisites.md b/src/prerequisites.md
@@ -25,3 +25,25 @@ environment integrated with [Visual Studio
 Code](https://code.visualstudio.com). Either clone the project and open it
 locally in Visual Studio Code and install the recommended plugins, or open it
 directly in a Github Codespace from the Github repository view.
+
+## A note on exercise hints and solutions
+
+We include hints or solutions for many exercises. By default they are
+displayed, but in collapsed form.
+
+```admonish example
+<details>
+<summary>Hint</summary>
+
+A hint
+</details>
+
+<details>
+<summary>Solution</summary>
+
+A solution
+</details>
+```
+
+If you would prefer even less temptation they can be hidden completely by
+pressing <kbd>F10</kbd> (try it now).