You can improve the collection description and teacher notes using markdown. Markdown is a simple text-format that allows you to add styles (such as headings, bold text, images) using plain text.
While editing collection descriptions or teacher notes in your class page, you can use markdown. Once saved, these will be rendered with the intended styles.
Markdown Cheatsheet
Headings:
#to######Emphasis:
*italic*,**bold**Inline code:
`code`Code blocks: triple backticks with an optional language (e.g.
```javascript)When you add the language, syntax highlighting will also be added if supported.
Links:
[text](https://example.com)(opens in a new tab)YouTube links: simply copy/paste a YouTube URL and it becomes an embedded video
Blockquotes:
> Helpful tip…Lists: numbered and bullet lists
Horizontal rule:
---Tables: pipe-delimited rows (see below)
Markdown Example
You can preview the markdown below on our example class page.
# Header
Here is a **bold** text, and *italic* for emphasis, and ~~strikethrough~~ for deleted text, super^script^ or sub~script~.
Add links with [a label](https://example.com) or just as is:
https://example.com
Add images just like links, but with an exclamation mark:
Here’s a code block:
```
// your code goes here
```
and one with syntax highlighting enabled:
```js
let name = "Alex";
function setup(){
print(name);
}
```
You can also include inline code like `let age = 30;` inside a sentence.
## Subheader
Here is a bullet list:
- Item 1
- Item 2
- Item 3
Here is numbered list:
1. Item 1
2. Item 2
> You can use blockquotes ('>') to
> highlight a section of the text
## Table Example
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
## Youtube Video
Just copy/paste the URL like below, and we will convert it to a inline video player.
https://www.youtube.com/watch?v=dQw4w9WgXcQ