Skip to content

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.

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.

You can embed specific sections of a note by referencing the heading:

![[note-name#Section Title]]

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.

Foam supports different embedding scopes and styles that can be configured globally or overridden per embed.

  • full - Include the entire note or section, including the title/heading
  • content - Include everything except the title/heading

Examples:

full![[my-note]] # Include title + content
content![[my-note]] # Content only, no title
  • card - Display the embedded content in a bordered container
  • inline - Display the content seamlessly as part of the current note

Examples:

card![[my-note]] # Bordered container
inline![[my-note]] # Seamless integration

You can combine scope and style modifiers:

full-card![[my-note]] # Title + content in bordered container
content-inline![[my-note]] # Content only, seamlessly integrated
full-inline![[my-note]] # Title + content, seamlessly integrated
content-card![[my-note]] # Content only in bordered container

Set your default embed behavior in VS Code settings:

{
"foam.preview.embedNoteType": "full-card"
}

Available options:

  • full-card (default)
  • full-inline
  • content-card
  • content-inline

Resize images to make your documents more readable:

![[image.png|300]] # 300 pixels wide
![[image.png|50%]] # Half the container width

Make large screenshots readable:

![[screenshot.png|600]]

Create responsive images:

![[diagram.png|70%]]

Size by width and height:

![[image.png|300x200]]

Center, left, or right align images:

![[image.png|300|center]]
![[image.png|300|left]]
![[image.png|300|right]]

Add descriptions for accessibility:

![[chart.png|400|Monthly sales chart]]
  • 300 or 300px - pixels (default)
  • 50% - percentage of container
  • 20em - relative to font size
  • 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: center not Center
Published with Foam