Example
Start
This section contains examples of supported markdown.
Also see The Wikipedia Article on Markdown.
Headers
Use two hash signs for the primary header
Secondary header
Create subheaders by using an additional hash sign
Tertiary header
You can keep going as deep as you want, but try to limit it to this level.
Basic formatting
Bold
Bold text is annotated using two stars on each side.
We typically use bold text to emphasize key terms.
Italic
Italic text is annotated using one star or underline on each side.
We typically use italic text when quoting passages or answer choices inline in a sentence.
Underline
Underlined text is annotated using the {`u`} tag on both sides.
We typically use underlined text to emphasize word stems like prefix or, or for fill-in-the-blank question choices in their passage.
Strikethrough
Strikethrough text is surrounded by two squiggles.
Lists
Bulleted lists are annotated with stars or dashes. Either is ok, but don’t mix and match in the same list. You can create a sub list item by indenting four spaces.
Unordered lists
Unordered list using stars
- List item
- Another list item
- Sub list item
Unordered list using dashes
- List item
- Another list item
- Sub list item
Ordered lists
Ordered list using numbers (note how {`1.`} is used for every element)
- First item
- Second item
- Sub item
- Second sub item
With another line of text - Third sub item
Links
You can add both external and internal links.
Images
If you want to add an image, you can! Talk to Brenden to learn how.
Whitespace
Markdown is very picky about the use of whitespace.
For creating whitespace, you can use: or $\;$
In the below examples, these options are used in between the words One and Two.
One Two
One Two
To create a new paragraph, you must have a completely empty line separating it. See how this sentence is part of the same paragraph although it’s on the next line?
You need to have a fully blank line between. Or, end the line with a backslash.
A backslash creates an inline break, where you get a newline, but it’s part of the same paragraph. This is useful when you have multi-line definitions, list items, etc.
Tables
Tables can be added to display data. Since the course is often used on mobile, prefer vertical tall and skinny tables over horizontal short and fat tables.
| Left aligned | Centered | Right aligned |
|---|---|---|
| 1111 | 2222 | 3333 |
| 1 | 2 | 3 |
The row after the headers is the alignment key.
Quotes
Pull quotes are used for quotes, quoted passages, and questions.
Single line quote
If you need multiple lines, start each with the symbol.
How many cats are in the bag?
A. Two
B. One
C. None, the cat is out of the bag
Note how a backslash or empty quoted line is needed to create newline breaks.
Custom components
Definitions
If you have terms to define, use a definitions box.
Callouts / sidenotes / keypoints
Callouts are like little warning banners to emphasize key info.
Sidenotes are like callouts, but usually used for information on a specific subtopic.
Keypoints are for summarizing sections, chapters, and ideas.
Use the {`block`} format for passage quotes or other long-form external content blocks.
Spoiler
Spoiler section can be hovered/clicked to show the content.
hello
Math
Inline equations
Inline equations are used by surrounding the equation with dollar signs. Do your best to include equations in the middle of a sentence like , rather than at the start or end.
Block equations
In general, prefer block equations instead of inline equations since they’re easier to read.
You can use equations in quotes or in other blocks.
Simplify the following expression:
It’s possible to include text in a math block.
Aligned equations
There are two primary ways to align equations.
For proper equations with equal signs, use the {`aligned`} tag. The ampersand & symbol marks an alignment point. Note how each line ends with two backslashes.
You can have multiple alignment points, but each line needs to have the same quantity.
For definitional equations, only include the defined term in the first line.
Prefer proper equations with equal signs, since they’re easier to read. But if you have a group, you can use the {`gather*`} tag.
Dollar sign
If you want to use inline equations with amounts of money, do the following:
He spent on the food.
Solve for .
Math symbols
Fractions
Fractions can be written vertically or horizontally, depending on the use.
Square roots
You can also write them as -roots.
Exponents
Use the ^ to make exponents.
You can also do negatives and numbers 10 or over using curly brackets.
You can also combine exponents and fractions.
Plus-minus
Less than and greater than
Less than or equal to and greater than or equal to
Division and multiplication signs
Percent sign
The percent sign can sometimes cause issues with formatting.
Percent sign is not showing up:
Percent sign not the same font: %
Use a slash to fix the issue:
Geometry and other math related symbols
You can make symbols for triangles.
You can make symbols for angles.
You can make symbols for different lines.
Other shapes
Circle
Square
Diamond