Skip to content

Latest commit

 

History

History
94 lines (72 loc) · 2.53 KB

blank-markdown.md

File metadata and controls

94 lines (72 loc) · 2.53 KB
Raw
layout root title
lesson
../..
Title of Lesson

Objectives

  • Describe the lesson's objectives in observable ways.
  • Not "understand X" (which isn't observable) but "Write a program that does X".
  • Aim for 3-6 points.
  • The <div> with class="objectives" gives this block the right style (and makes it findable), the markdown="1" attribute tells Jekyll to process the content of the div as Markdown rather than HTML.
  • Keep the blank lines between the opening <div ...> and the closing </div> and these bullet points.

First section

Our sections start at <h3> or ### (in Markdown).

Second section

Write paragraphs of text here. When you need to show input, output, and errors, put a triple tilde ~~~ before and after like this:

content of data file
second line of data file
yup, more data

If the block is input, output, or error text, add a class specifier as shown below:

$ this is the input

{:class="in"}

this is the output

{:class="out"}

error message

{:class="err"}

We use these classes to be consistent with the HTML we produce for IPython Notebooks, and because novices find examples much easier to read when they can clearly distinguish input from output.

Callout Boxes

Use a quoted block like this with a level-4 heading to write side notes.

These notes can span multiple paragraphs and include code blocks, but please try to keep them short.

Whenever you define a term, include a link to the gloss.html file in the root directory. Note that this file doesn't exist in the repository: it is produced during website compilation from gloss.md.

Images should be stored in the img directory below the lesson directory. Please use SVG for diagrams, since it scales better than raster formats like PNG or JPEG. Please also include alternate text for accessibility aids and search engines:

<img src="img/filesystem.svg" alt="The Filesystem" />

Key Points

  • Every lesson should end with a summary of key points.
  • We will stitch these together to create reference guides for learners.
  • As with objectives, wrap this block in a div with the right style and markdown="1".

Challenges

  1. Include a list of challenge exercises for learners at the end of the lesson.

  2. Put blank lines between the items so that the challenges will be spaced out in the final HTML document.