diff --git a/docs/assets/images/note-embed-type-demo.gif b/docs/assets/images/note-embed-type-demo.gif new file mode 100644 index 000000000..759a456da Binary files /dev/null and b/docs/assets/images/note-embed-type-demo.gif differ diff --git a/docs/user/features/built-in-note-embedding-types.md b/docs/user/features/built-in-note-embedding-types.md new file mode 100644 index 000000000..64cd6e54d --- /dev/null +++ b/docs/user/features/built-in-note-embedding-types.md @@ -0,0 +1,29 @@ +# Built-In Note Embedding Types + +When embedding a note, there are a few ways to modify the scope of the content as well as its display style. The following are Foam keywords that are used to describe note embedding. + +Note, this only applies to note embedding, not embedding of attachments or images. + +![Note Embed Types GIF](../../assets/images/note-embed-type-demo.gif) + +## Scope + +- `full` - the entire note in the case of `![[note]]` or the entire section in the case of `![[note#section1]]` +- `content` - everything excluding the title of the section. So the entire note minus the title for `![[note]]`, or the entire section minus the section header for `![[note#section1]]` + +## Style + +- `card` - outlines the embedded note with a border +- `inline` - adds the note continuously as if the text were part of the calling note + +## Default Setting + +Foam expresses note display type as `-