From fe05ee560ad382bc247d3f3f82c24e43a3ba0f91 Mon Sep 17 00:00:00 2001 From: Richard Darst Date: Wed, 30 Oct 2024 13:44:07 +0200 Subject: [PATCH] Add a template episode within the template --- content/episode.md | 93 ++++++++++++++++++++++++++++++++++++++++++++++ content/index.md | 2 + 2 files changed, 95 insertions(+) create mode 100644 content/episode.md diff --git a/content/episode.md b/content/episode.md new file mode 100644 index 0000000..28b875b --- /dev/null +++ b/content/episode.md @@ -0,0 +1,93 @@ +# Episode template + +:::{questions} +- What syntax is used to make a lesson? +- How do you structure a lesson effectively for teaching? +- `questions` are at the top of a lesson and provide a starting + point for what you might learn. It is usually a bulleted list. +::: + +:::{objectives} +- Show a complete lesson page with all of the most common + structures. +- ... + +This is also a holdover from the carpentries-style. It could +usually be left off. +::: + + + + +The introduction should be a high level overview of what is on the +page and why it is interesting. + + +The lines below (only in the source) will set the default highlighting +language for the entire page. + +:::{highlight} python +::: + + + +## Section + +A section. + +:::{discussion} +Discuss the following. + +- A discussion section +- Another discussion topic +::: + + + +## Section + +``` +print("hello world") +# This uses the default highlighting language +``` + +```python +print("hello world) +``` + + + +## Exercises: description + +:::{exercise} Exercise Topic-1: imperative description of exercise +Exercise text here. +::: + +:::{solution} +Solution text here +::: + + + +## Summary + +A Summary of what you learned and why it might be useful. Maybe a +hint of what comes next. + + + +## See also + +- Other relevant links +- Other link + + + +:::{keypoints} +- What the learner should take away +- point 2 +- ... + +This is another holdover from the carpentries style. This perhaps +is better done in a "summary" section. +::: diff --git a/content/index.md b/content/index.md index e9fcde0..60cb2bd 100644 --- a/content/index.md +++ b/content/index.md @@ -16,6 +16,8 @@ prerequisites ```{toctree} :caption: The lesson :maxdepth: 1 + +episode.md ``` ```{toctree}