Note Embeds
Embeds allow you to include content from other notes directly into your current note. This is powerful for creating dynamic content that updates automatically when the source note changes.
If you want to embed a dynamic list or table of notes instead of the content of one note, see Foam Queries.
Basic Syntax
Section titled “Basic Syntax”Use the embed syntax with an exclamation mark before the wikilink:
![[note-name]]This will embed the entire content of note-name into your current note.
Embedding Sections
Section titled “Embedding Sections”You can embed specific sections of a note by referencing the heading:
![[note-name#Section Title]]Embedding Blocks
Section titled “Embedding Blocks”Embed a specific paragraph, list item, heading, or blockquote using a block anchor:
![[note-name#^blockid]]See Block Anchors for how to add ^id markers to your notes.
Embed Types
Section titled “Embed Types”Foam supports different embedding scopes and styles that can be configured globally or overridden per embed.
Scope Modifiers
Section titled “Scope Modifiers”full- Include the entire note or section, including the title/headingcontent- Include everything except the title/heading
Examples:
full![[my-note]] # Include title + contentcontent![[my-note]] # Content only, no titleStyle Modifiers
Section titled “Style Modifiers”card- Display the embedded content in a bordered containerinline- Display the content seamlessly as part of the current note
Examples:
card![[my-note]] # Bordered containerinline![[my-note]] # Seamless integrationCombined Modifiers
Section titled “Combined Modifiers”You can combine scope and style modifiers:
full-card![[my-note]] # Title + content in bordered containercontent-inline![[my-note]] # Content only, seamlessly integratedfull-inline![[my-note]] # Title + content, seamlessly integratedcontent-card![[my-note]] # Content only in bordered containerConfiguration
Section titled “Configuration”Set your default embed behavior in VS Code settings:
{ "foam.preview.embedNoteType": "full-card"}Available options:
full-card(default)full-inlinecontent-cardcontent-inline
Image Sizing
Section titled “Image Sizing”Resize images to make your documents more readable:
![[image.png|300]] # 300 pixels wide![[image.png|50%]] # Half the container widthCommon Use Cases
Section titled “Common Use Cases”Make large screenshots readable:
![[screenshot.png|600]]Create responsive images:
![[diagram.png|70%]]Size by width and height:
![[image.png|300x200]]Alignment
Section titled “Alignment”Center, left, or right align images:
![[image.png|300|center]]![[image.png|300|left]]![[image.png|300|right]]Alt Text
Section titled “Alt Text”Add descriptions for accessibility:
![[chart.png|400|Monthly sales chart]]300or300px- pixels (default)50%- percentage of container20em- relative to font size
Troubleshooting
Section titled “Troubleshooting”- Check image path:
![[path/to/image.png|300]] - No spaces around pipes:
|300|not| 300 | - Images only resize in preview mode, not edit mode
- Use lowercase alignment:
centernotCenter