Callouts, highlights, and comments
Visual hierarchy transforms dense reference notes into legible working documents. Oyma provides full support for Obsidian-compatible callout callouts, inline highlights, margin comments, and footnotes.
Supported callout types
Callouts are written using extended blockquote syntax: > [!TYPE] Optional Title. Oyma renders them with distinct icon badges and color accents:
| Callout type | Syntax | Usage |
|---|---|---|
| Note | > [!NOTE] | General context and reference information |
| Tip | > [!TIP] | Best practices, optimizations, and shortcuts |
| Warning | > [!WARNING] | Technical cautions and prerequisite warnings |
| Important | > [!IMPORTANT] | Critical steps and non-negotiable requirements |
| Caution | > [!CAUTION] | High-risk actions and irreversible changes |
| Quote | > [!QUOTE] | Verbatim citations and interview quotes |
| Todo | > [!todo] | Action item checklists within reference blocks |
Callout example
> [!WARNING] Production Database Migration
> Ensure snapshot replication completes before applying schema alters.
> - Verify disk space on volume `/data`
> - Confirm standby failover is healthyCollapsible callouts
Control document density by making callouts collapsible:
- Expandable (collapsed by default): Use a minus sign:
> [!NOTE]- Technical Implementation Details > This section is folded until clicked. - Collapsible (expanded by default): Use a plus sign:
> [!NOTE]+ Architectural Overview > This section is open on load but can be collapsed.
Highlights, comments, and footnotes
- Highlights: Wrap text in double equal signs:
==critical metric==. - Inline Comments: Wrap text in double percent signs:
%%private editorial note%%. Comments are preserved in plain text on disk but hidden in reader view. - Footnotes: Add a reference tag
[^1]and define the note at the end of the file:Meeting recorded with dual-channel isolation[^1]. [^1]: See ScreenCaptureKit loopback pipeline documentation.
Related guides
- Learn basic formatting in Markdown basics.
- Export styled documents in Exporting notes to PDF and DOCX.
- Organize files in Obsidian vault setup.
Questions
Are callouts compatible with Obsidian?
Yes. Oyma uses the exact CommonMark blockquote syntax (`> [!NOTE]`) recognized by Obsidian.
Can callouts be collapsed by default?
Yes. Add a minus sign after the type (`> [!NOTE]-`) to render the callout collapsed by default.
How do highlights save in raw files?
Highlights are stored as standard `==highlighted text==` syntax, readable in any plain text editor.
