Chalk Syntax Reference
A comprehensive reference for all Chalk syntax patterns.
Quick Reference
| Pattern | Description |
|---|---|
#, ##, ### |
Headings |
!!! |
Embed block (images, motion, video, transclusion) |
??? |
Prompt block (quiz, reflection, instruction) |
[x], [ ] |
Answer markers for quizzes |
==highlight== |
Highlighted text |
<<Shift + R>> |
Keystroke marker |
::Label:: |
Clapper (UI label marker) |
{{{ … }}} |
Internal notes |
::: |
Callout blocks |
Detailed Syntax
Headings
# Main Heading
## Secondary Heading
### Tertiary Heading
#### Fourth Level Heading
Text Formatting
**Bold text**
*Italic text*
==Highlighted text==
<<Command + S>> (keystrokes)
::Fixed:: (clappers/UI labels)
[Link text](https://example.com)
Lists
# Unordered lists
- Item 1
- Item 2
- Item 3
# Ordered lists
1. First step
2. Second step
3. Third step
Embed Blocks (!!!)
!!!
image.png
[Alt text for accessibility]
Caption text goes here.
!!!
Prompt Blocks (???)
# Simple prompt
???
What did you learn from this lesson?
???
# Quiz with answers
???
What is the purpose of a wireframe?
[ ] To polish final design
Wireframes are typically used earlier in the process.
[x] To plan structure and layout
Correct! This is their main purpose.
???
Internal Notes ({{{ and }}})
{{{
TODO: This is a note for internal use only.
}}}
Callout Blocks (:::)
:::
This is a callout for important information.
:::
Best Practices
- Use descriptive alt text for all images
- Keep prompts focused and actionable
- Use internal notes for TODO items and private comments
- Structure content with clear headings
- Test your syntax in a preview before publishing