• Basic Syntax

    Chalk extends Markdown with a few lightweight patterns to make authoring course content easier.

    Basic Building Blocks

    1. Headings, paragraphs, lists

    Just like regular Markdown:

    ## Understanding Visual Hierarchy
    
    Visual hierarchy helps users understand what's important.
    You can use size, contrast, spacing, and alignment to guide attention.
    
    - Headings
    - Buttons
    - Images
    

    2. Embed Blocks (!!!)

    Use !!! blocks to embed images, videos, or motion content.

    !!!
    figure-01.png
    
    [Flow diagram of the onboarding steps.]
    
    This visual illustrates the user journey from welcome to profile.
    
    <https://figma.com/file/abc123>
    !!!
    
    • [Alt text] goes in brackets on its own line
    • You can include a filename, description, caption, credit, or source link
    • Links can be bare (https://...) or in angle brackets (<https://...>)
    • For videos, you can add flags like ?loop&autoplay to control behavior

    You can start with just a description, or even just the block itself:

    !!!
    image
    !!!
    

    Or the simplest placeholder:

    !!!
    !!!
    

    3. Prompt Blocks (???)

    Use ??? blocks to prompt reflections, encourage active learning, or outline instructional steps.

    ???
    What is a component in Figma?
    ???
    

    Or leave it empty for now:

    ???
    ???
    

    You can use ??? blocks to ask students to reflect or take action.

    ???
    Think of a digital product you use often.
    What visual cues help you understand how to use it?
    ???
    

    You can use ??? blocks to indicate a set of instructional steps for a learner to follow:

    ???
    1. Open the file.
    2. Press <<R>> to use the Rectangle tool.
    3. Click and drag a rectangle on the canvas.
    4. With the rectangle still selected, press <<Shift + X>> to swap the fill and outline colors.
    ???
    

    4. Quiz Blocks (??? with answers)

    Use ??? blocks with multiple-choice answers for quick checks or self-assessments.

    ???
    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.
    ???
    
    • [x] = correct answer
    • [ ] = incorrect answer
    • Include feedback after each option

    5. Inline Styling

    You can use standard markdown formatting:

    Use bold text to **add strong emphasis**.
    
    Use italic text to _add emphasis_.
    
    Use a link to reference [a resource](https://buttonschool.com).
    

    Chalk also supports some additional formatting:

    You can ==highlight a key word or phrase==.
    
    You can mark keystrokes like <<Shift + Return>> or <<Command + R>>.
    
    You can mark UI labels like ::Fixed:: or ::Clip content::.
    

    These are all intended to add clarity and intention to our writing, in ways that feel natural to write, and add expressiveness to what our writing means.