Skip to content

Commit

Permalink
Add a template episode within the template
Browse files Browse the repository at this point in the history
  • Loading branch information
rkdarst committed Oct 30, 2024
1 parent 5364dcd commit fe05ee5
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 0 deletions.
93 changes: 93 additions & 0 deletions content/episode.md
Original file line number Diff line number Diff line change
@@ -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.
:::
2 changes: 2 additions & 0 deletions content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ prerequisites
```{toctree}
:caption: The lesson
:maxdepth: 1
episode.md
```

```{toctree}
Expand Down

0 comments on commit fe05ee5

Please sign in to comment.