michael-f-bryan/summary-callout

Summary Callout

When creating or editing markdown notes, include a summary callout at the beginning (after frontmatter if present) using > [!summary].

Structure

• Place at the top of the note, after frontmatter
• Format: > [!summary] followed by the summary content
• Length: 1–3 sentences, or 3–5 bullet points for complex topics

Content

• Capture the core idea without supporting detail
• Answer: What is it? and Why is it important?
• Include key relationships to other concepts when relevant
• Clear, direct, professional tone; active voice; present tense
• Avoid jargon unless essential

Formatting

• Use italics or bold for critical terms
• Use backticks for code/technical terms
• Use bullet points for complex summaries
• Include essential [[wikilinks]] to related concepts only—don’t overload

By context

| Context | Focus | | ----------------------- | -------------------------------------------------- | | Technical concepts | What it is and its primary purpose | | Entities | Type and key characteristics | | Educational content | TL;DR with key insights and practical applications |

Do

• Make the summary stand alone as a quick reference
• Include all essential elements
• Revise when main content changes
• Keep formatting consistent across notes

Avoid

• Summaries that are mini-articles
• Vague phrasing (“This note is about X”)
• Too many links
• Duplicating the first paragraph
• Relying on external context the reader doesn’t have