Skip to content

Commit 3b9a89c

Browse files
committed
add formatting and sample episodes
1 parent 1f16683 commit 3b9a89c

2 files changed

Lines changed: 625 additions & 0 deletions

File tree

_episodes/02-Practice-Area.md

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
title: Practice area
3+
teaching: 30
4+
exercises: 1
5+
questions:
6+
- Try making various examples yourself
7+
objectives:
8+
- Learn how to format different use cases
9+
keypoints:
10+
- Using Markdown to make note/warnings/quizzes
11+
---
12+
13+
14+
15+
---
16+
17+
1. Make a Note
18+
19+
~~~
20+
> ## Note check out the Markdown CheatSheet for standard syntax
21+
> check out the Markdown CheatSheet for standard syntax
22+
> [Cheat Sheet for Markdown](https://www.markdownguide.org/cheat-sheet/)
23+
{: .callout}
24+
~~~
25+
{: .source}
26+
27+
Produces:
28+
29+
> ## Note check out the Markdown CheatSheet for standard syntax
30+
> check out the Markdown CheatSheet for standard syntax
31+
> [Cheat Sheet for Markdown](https://www.markdownguide.org/cheat-sheet/)
32+
{: .callout}
33+
34+
35+
36+
These tutorials use some addons. See [Formatting episode]({{ page.root }}{% link _episodes/04-formatting.md %}) for details.
37+
38+
39+
---
40+
41+
42+
> ## I have to indent the text within a particular numbered section or the number resets
43+
{: .callout}
44+
45+
2. Refer to a different episode
46+
47+
~~~
48+
[Formatting episode]({{ page.root }}{% link _episodes/04-formatting.md %})
49+
~~~
50+
{: .source}
51+
52+
Produces:
53+
54+
[Formatting episode]({{ page.root }}{% link _episodes/04-formatting.md %})
55+
56+
---
57+
58+
3. Show me some source code
59+
60+
~~~
61+
for thing in collection:
62+
do_something
63+
~~~
64+
{: .source}
65+
66+
or you can use specific language specifiers like `{: .language-python}`
67+
68+
Please write code so that people can copy directly over to their terminal to run it. No terminal prompts at the beginning of lines.
69+
70+
---
71+
72+
4. Ask me a tricky question
73+
74+
~~~
75+
> ## Challenge Title
76+
>
77+
> What happens if I type?
78+
>
79+
> ~~~
80+
> rm -rf *
81+
> ~~~
82+
> {: .source}
83+
>
84+
> > ## Solution
85+
> >
86+
> > This is a bad thing to do
87+
> >
88+
> > ~~~
89+
> > You have deleted all your files
90+
> > ~~~
91+
> > {: .output}
92+
> {: .solution}
93+
{: .challenge}
94+
~~~
95+
{: .source}
96+
97+
Produces:
98+
99+
> ## Challenge Title
100+
>
101+
> What happens if I type
102+
>
103+
> ~~~
104+
> rm -rf *
105+
> ~~~
106+
> {: .source}
107+
>
108+
> > ## Solution
109+
> >
110+
> > This is a bad thing to do
111+
> >
112+
> > ~~~
113+
> > You have deleted all your files
114+
> > ~~~
115+
> > {: .output}
116+
> {: .solution}
117+
{: .challenge}
118+
119+
---
120+
121+
5. Make certain you can version things so the lesson is easy to keep up to date.
122+
123+
~~~
124+
export CODE_VERSION=v20
125+
~~~
126+
{: .language-bash}
127+
128+
Allows you to do
129+
130+
~~~
131+
setup $CODE_VERSION
132+
~~~
133+
{: .language-bash}
134+
135+
throughout your lesson.
136+
137+
(Visual code and other editors also allow you to do global changes if you have to. )

0 commit comments

Comments
 (0)