Skip to content

Contribution cheat sheet

Learning Objectives

  • To understand the markdown syntax used in the Run 3 Starterkit
  • How to convert Run 2 style markdown to be in the Run 3 syntax
  • The standard practices used in these lessons

Listed here are instructions on how to add make various non-standard markdown to your lessons such as admonitions and \(\LaTeX\). As well, we also list the syntax for how this was done in the old Starterkit lessons, if you are converting blocks from those lessons.

Admonitions

Also called callouts, these are blocks of text which stand out from the other text. The syntax for how to write these is as follows:

!!! abstract "Learning Objectives"
    The learning objectives block is now separated by four spaces (exactly).

Normal text will resume outside of the indented block

{% objectives "Learning Objectives" %}

The old Starterkit style was formatted like this

{% endobjectives %}

There are different styles of admonitions which may be used.

Abstract

'abstract' is generally used for the learning objectives.

Info

'info' is generally used for information which needs to stand out.

Note

'note' is generally used for exercises or where there are tasks to be tried by the reader.

Warning

'warning' is for warnings!

There are a full list of admonitions which may be found on the mkdocs webpage.

Linking to other pages

The syntax for linking across the between Starterkit lessons is slightly different.

[bookkeeping lesson](./bookkeeping.en.md)

The text will now read `bookkeeping lesson` as a clickable link to the bookkeeping lesson. Note that the path is relative.

[bookkeeping lesson](bookkeeping)

The old Starterkit style was formatted like this

\(\LaTeX\)

\(\LaTeX\) may be added in-line using escaped round brackets or in a block using escaped square brackets.

Here is some \\(\LaTeX\\) inline. A block of \\(\LaTeX\\) may be written as:

\\[
    a^2 + b^2 = c^2
\\]

Here is some $\LaTeX$ inline. A block of $\LaTeX$ may be written as:

$$
    a^2 + b^2 = c^2
$$

Footnotes

Footnotes may be added and will link to each other automatically.1

The syntax for this is consistent between the new and old styles, first add a carret in square brackets.[^1]

Then the rest of the lesson may continue as normal.

[^1]:
    Finally at the bottom of the page, indented by four spaces (exactly), the footnote will be found.
    It will link up automatically.

  1. The footnotes will appear at the bottom of the page. ↩