From f57b8ec9b676c2fe7615c2f76d24e7275ebf5972 Mon Sep 17 00:00:00 2001 From: Riccardo Ferretti Date: Sat, 6 Sep 2025 11:54:15 +0200 Subject: [PATCH] Updated documentation --- .../Achieving Greater Privacy and Security.md | 29 --- docs/big-vision.md | 17 -- docs/dev/foam-file-format.md | 9 +- docs/index.md | 128 ++++----- docs/reading-list.md | 10 - docs/terminology.md | 19 -- docs/user/__foam todo.md | 6 + docs/user/features/backlinking.md | 76 +++++- .../features/built-in-note-embedding-types.md | 29 --- docs/user/features/daily-notes.md | 65 ++--- docs/user/features/embeds.md | 77 ++++++ .../{graph-visualization.md => graph-view.md} | 26 +- docs/user/features/including-notes.md | 23 -- .../features/link-reference-definitions.md | 119 ++++----- docs/user/features/note-properties.md | 6 +- docs/user/features/tags.md | 113 ++++---- .../{note-templates.md => templates.md} | 0 docs/user/features/wikilinks.md | 55 ++-- .../getting-started/creating-new-notes.md | 15 -- docs/user/getting-started/first-workspace.md | 209 +++++++++++++++ .../get-started-with-vscode.md | 245 ++++++++++++++++-- docs/user/getting-started/installation.md | 79 ++++++ docs/user/getting-started/navigation.md | 162 ++++++++++++ .../getting-started/note-taking-in-foam.md | 239 +++++++++++++++++ .../getting-started/recommended-extensions.md | 24 +- ...s-with-source-control.md => sync-notes.md} | 0 .../getting-started/write-notes-in-foam.md | 74 ------ docs/user/index.md | 55 ++-- .../recipes/make-backlinks-more-prominent.md | 21 -- docs/user/recipes/note-macros.md | 58 ----- docs/user/recipes/recipes.md | 6 +- 31 files changed, 1390 insertions(+), 604 deletions(-) delete mode 100644 docs/Achieving Greater Privacy and Security.md delete mode 100644 docs/big-vision.md delete mode 100644 docs/reading-list.md delete mode 100644 docs/terminology.md create mode 100644 docs/user/__foam todo.md delete mode 100644 docs/user/features/built-in-note-embedding-types.md create mode 100644 docs/user/features/embeds.md rename docs/user/features/{graph-visualization.md => graph-view.md} (80%) delete mode 100644 docs/user/features/including-notes.md rename docs/user/features/{note-templates.md => templates.md} (100%) delete mode 100644 docs/user/getting-started/creating-new-notes.md create mode 100644 docs/user/getting-started/first-workspace.md create mode 100644 docs/user/getting-started/installation.md create mode 100644 docs/user/getting-started/navigation.md create mode 100644 docs/user/getting-started/note-taking-in-foam.md rename docs/user/getting-started/{sync-notes-with-source-control.md => sync-notes.md} (100%) delete mode 100644 docs/user/getting-started/write-notes-in-foam.md delete mode 100644 docs/user/recipes/make-backlinks-more-prominent.md delete mode 100644 docs/user/recipes/note-macros.md diff --git a/docs/Achieving Greater Privacy and Security.md b/docs/Achieving Greater Privacy and Security.md deleted file mode 100644 index 9a2666fe..00000000 --- a/docs/Achieving Greater Privacy and Security.md +++ /dev/null @@ -1,29 +0,0 @@ -# Achieving Greater Privacy and Security - -Foam, at its heart and committed to in its [Principles](https://foambubble.github.io/foam/principles), allows the user to control their content in a flexible and non-prescriptive manner. This extends to user preferences, or requirements depending on application and context, around both privacy and security. One way that these use cases can be met is through the use of open-source and not-for-profit mechanisms in the user's workflow to provide a functional equivalence. - -Here are a few suggestions on increasing privacy and security when using Foam. -## VS Codium: The Open Source build of VS Code - -Foam is built upon VS Code, itself a Microsoft product built on top of an open source project. - -As can be found [here](https://github.com/Microsoft/vscode/issues/60#issuecomment-161792005) the **VS Code product itself is not fully open source**. This means that its inner workings are not fully transparent, facilitating the collection and distribution of your data, as specified in its [Privacy Statement](https://devblogs.microsoft.com/visualstudio/privacy/). - -If you prefer a fully open source editor based on the same core of VS Code (and for most intents and purposes equivalent to it), you can try [VSCodium](https://github.com/VSCodium). -In its own introduction it is described as, "Binary releases of VS Code without MS branding/telemetry/licensing". Installation packages are easily available across Windows, Unix and Linux (or you can build it from source!). -Access to the VS Code marketplace of add-ons remains in place, including the Foam extension. - -The change you will notice in using VS Code versus VS Codium - simply speaking, none. It is, in just about every way you will think of, the same IDE, just without the Microsoft proprietary licence and telemetry. Your Foam experience will remain as smooth and productive as before the change. - -## Version Control and Replication - -In Foam's [Getting Started](https://foambubble.github.io/foam/#getting-started) section, the set up describes how to set up your notes with a GitHub repository in using the template provided. Doing so provides the user with the ability to see commits made and therefore versions of their notes, allows the user to work across devices or collaborate effectively with other users, and makes publishing to GitHub pages easy. -It's important at the same time to point out the closed-source nature of GitHub, being owned by Microsoft. - -One alternative approach could be to use [GitLab](https://gitlab.com/), an open source alternative to GitHub. Whilst it improves on the aspect of transparency, it does also collect usage details and sends your content across the internet. -And of course data is still stored in clear in the cloud, making it susceptible to hacks of the service. - -A more private approach would manage replication between devices and users with a serverless mechanism like [Syncthing](https://syncthing.net). Its continuous synchronisation means that changes in files are seen almost instantly and offers the choice of using only local network connections or securely using public relays when a local network connection is unavailable. This means that having two connected devices online will have them synchronised, but it is worth noting that the continuous synchronisation could result in corruption if two users worked on the same file simultaneously and it doesn't offer the same kind of version control that git does (though versioning support can be found and is described [here](https://docs.syncthing.net/users/versioning.html)). It is also not advisable to attempt to use a continuous synchronisation tool to sync local git repositories as the risk of corruption on the git files is high (see [here](https://forum.syncthing.net/t/can-syncthing-reliably-sync-local-git-repos-not-github/8404/18)). - -If you need the version control and collaboration, but do not want to compromise on your privacy, the best course of action is to host the open source GitLab server software yourself. The steps (well described [here](https://www.techrepublic.com/article/how-to-set-up-a-gitlab-server-and-host-your-own-git-repositories/)) are not especially complex by any means and can be used exclusively on the local network, if required, offering a rich experience of "built-in version control, issue tracking, code review, CI/CD, and more", according to its website, [GitLab / GitLab Community Edition · GitLab](https://gitlab.com/rluna-gitlab/gitlab-ce). - diff --git a/docs/big-vision.md b/docs/big-vision.md deleted file mode 100644 index cc5c75a4..00000000 --- a/docs/big-vision.md +++ /dev/null @@ -1,17 +0,0 @@ -# Big Vision - -[[todo]] - -- What methodologies do we want to support? - - Zettelkasten? - - GTD? (Get Things Done) - - Digital gardening? - - Blogging/publishing - - Others? -- Be an educational tool as much as a tool to implement these methodologies -- What use cases are we working towards? - -[[todo]] User round table - -[//begin]: # "Autogenerated link references for markdown compatibility" -[todo]: dev/todo.md "Todo" -[//end]: # "Autogenerated link references" diff --git a/docs/dev/foam-file-format.md b/docs/dev/foam-file-format.md index 8be53273..95405f53 100644 --- a/docs/dev/foam-file-format.md +++ b/docs/dev/foam-file-format.md @@ -1,6 +1,6 @@ # Foam File Format -This file is an example of a valid Foam file. Essentially it's just a markdown file with a bit of additional support for MediaWiki-style `[[wikilinks]]`. +This file is an example of a valid Foam file. Essentially it's just a markdown file with a bit of additional support for MediaWiki-style `[[wikilinks]]` and note embeds. Here are a few specific constraints, mainly because our tooling is a bit fragmented. Most of these should be eventually lifted, and our requirement should just be "Markdown with `[[wikilinks]]`: @@ -10,7 +10,8 @@ Here are a few specific constraints, mainly because our tooling is a bit fragmen - This is a temporary limitation and will be lifted in future versions. - At least `.mdx` will be supported, but ideally we'll support any file that you can map to `Markdown` language mode in VS Code - **In addition to normal Markdown Links syntax you can use `[[MediaWiki]]` links.** See [[wikilinks]] for more details. +- **You can embed other notes using `![[note]]` syntax.** This supports various modifiers like `content![[note]]` or `full-card![[note]]` to control how content is displayed. -[//begin]: # "Autogenerated link references for markdown compatibility" -[wikilinks]: ../user/features/wikilinks.md "Wikilinks" -[//end]: # "Autogenerated link references" +[//begin]: # 'Autogenerated link references for markdown compatibility' +[wikilinks]: ../user/features/wikilinks.md 'Wikilinks' +[//end]: # 'Autogenerated link references' diff --git a/docs/index.md b/docs/index.md index e4608d4d..68d29f64 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,25 @@ -# Foam +# What is Foam? -**Foam** is a personal knowledge management and sharing system inspired by [Roam Research](https://roamresearch.com/), built on [Visual Studio Code](https://code.visualstudio.com/) and [GitHub](https://github.com/). +Foam is a personal knowledge management system built on [Visual Studio Code](https://code.visualstudio.com/) and [GitHub](https://github.com/). It helps you organize research, create discoverable notes, and publish your knowledge. -You can use **Foam** for organising your research, keeping re-discoverable notes, writing long-form content and, optionally, publishing it to the web. +## Key Features -**Foam** is free, open source, and extremely extensible to suit your personal workflow. You own the information you create with Foam, and you're free to share it, and collaborate on it with anyone you want. +- **Wikilinks** - Connect thoughts with `[[double bracket]]` syntax +- **Embeds** - Include content from other notes with `![[note]]` syntax +- **Backlinks** - Automatically discover connections between notes +- **Graph visualization** - See your knowledge network visually +- **Daily notes** - Capture timestamped thoughts +- **Templates** - Standardize note creation +- **Tags** - Organize and filter content + +## Why Choose Foam? + +- **Free and open source** - No subscriptions or vendor lock-in +- **Own your data** - Notes stored as standard Markdown files +- **VS Code integration** - Leverage powerful editing and extensions +- **Git-based** - Version control and collaboration built-in + +Foam is like a bathtub: _What you get out of it depends on what you put into it._

New! Join Foam community Discord for users and contributors! @@ -17,88 +32,79 @@ You can use **Foam** for organising your research, keeping re-discoverable notes ## Table of Contents -- [Foam](#foam) +- [What is Foam?](#what-is-foam) + - [Key Features](#key-features) + - [Why Choose Foam?](#why-choose-foam) - [Table of Contents](#table-of-contents) - [How do I use Foam?](#how-do-i-use-foam) - [What's in a Foam?](#whats-in-a-foam) - [Getting started](#getting-started) - [Features](#features) - - [Call To Adventure](#call-to-adventure) + - [Contributing](#contributing) - [Thanks and attribution](#thanks-and-attribution) - [License](#license) ## How do I use Foam? -**Foam** is a tool that supports creating relationships between thoughts and information to help you think better. +Foam helps you create relationships between thoughts and information through: -Whether you want to build a [Second Brain](https://www.buildingasecondbrain.com/) or a [Zettelkasten](https://zettelkasten.de/posts/overview/), write a book, or just get better at long-term learning, **Foam** can help you organise your thoughts if you follow these simple rules: +1. **Atomic notes** - Write focused markdown documents on single topics +2. **Wikilinks** - Connect ideas with `[[double bracket]]` syntax +3. **Backlinks** - Discover unexpected connections between notes +4. **Graph visualization** - See your knowledge network visually -1. Create a single **Foam** workspace for all your knowledge and research following the [Getting started](#getting-started) guide. -2. Write your thoughts in markdown documents (I like to call them **Bubbles**, but that might be more than a little twee). These documents should be atomic: Put things that belong together into a single document, and limit its content to that single topic. ([source](https://zettelkasten.de/posts/overview/#principles)) -3. Use Foam's shortcuts and autocompletions to link your thoughts together with `[[wikilinks]]`, and navigate between them to explore your knowledge graph. -4. Get an overview of your **Foam** workspace using a [[graph-visualization]] (⚠️ WIP), and discover relationships between your thoughts with the use of [[backlinking]]. - -Foam is a like a bathtub: _What you get out of it depends on what you put into it._ +Success with Foam depends on consistent note-taking and linking habits. ## What's in a Foam? -Like the soapy suds it's named after, **Foam** is mostly air. +Foam combines existing tools: -1. The editing experience of **Foam** is powered by VS Code, enhanced by workspace settings that glue together [[recommended-extensions]] and preferences optimised for writing and navigating information. -2. To back up, collaborate on and share your content between devices, Foam pairs well with [GitHub](http://github.com/). -3. To publish your content, you can set it up to publish to [GitHub Pages](https://pages.github.com/), or to any website hosting platform like [Netlify](http://netlify.com/) or [Vercel](https://vercel.com). +1. **VS Code** - Enhanced with [[recommended-extensions]] optimized for knowledge management +2. **GitHub** - Version control, backup, and collaboration +3. **Static site generators** - Publish to GitHub Pages, Netlify, or Vercel -> **Fun fact**: This documentation was researched, written and published using **Foam**. +> This documentation was created using Foam. ## Getting started -> ⚠️ Foam is still in preview. Expect the experience to be a little rough. +**Requirements:** GitHub account and Visual Studio Code -These instructions assume you have a GitHub account, and you have Visual Studio Code installed. - -1. Use the [foam-template project](https://github.com/foambubble/foam-template) to generate a new repository. If you're logged into GitHub, you can just hit this button: +1. **Create repository** - Use the [foam-template](https://github.com/foambubble/foam-template) to generate a new repository Use this template - _If you want to keep your thoughts to yourself, remember to set the repository private, or if you don't want to use GitHub to host your workspace at all, choose [**Download as ZIP**](https://github.com/foambubble/foam-template/archive/main.zip) instead of **Use this template**._ +2. **Clone and open** - Clone locally and open the folder in VS Code +3. **Install extensions** - Click "Install all" when prompted for recommended extensions +4. **Configure** - Edit `.vscode/settings.json` for your preferences -2. [Clone the repository locally](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) and open it in VS Code. +**Next steps:** - _Open the repository as a folder using the `File > Open...` menu item. In VS Code, "open workspace" refers to [multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces)._ - -3. When prompted to install recommended extensions, click **Install all** (or **Show Recommendations** if you want to review and install them one by one) - -After setting up the repository, open `.vscode/settings.json` and edit, add or remove any settings you'd like for your Foam workspace. - -- _If using a [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) as noted above, make sure that your **Foam** directory is first in the list. There are some settings that will need to be migrated from `.vscode/settings.json` to your `.code-workspace` file._ - -To learn more about how to use **Foam**, read the [[recipes]]. - -Getting stuck in the setup? Read the [[frequently-asked-questions]]. - -Check our [issues on GitHub](http://github.com/foambubble/foam/issues) if you get stuck on something, and create a new one if something doesn't seem right! +- Explore the [[recipes]] for usage patterns +- Check [[frequently-asked-questions]] if you need help +- Report issues on [GitHub](http://github.com/foambubble/foam/issues) ## Features -**Foam** doesn't have features in the traditional sense. Out of the box, you have access to all features of VS Code and all the [[recommended-extensions]] you choose to install, but it's up to you to discover what you can do with it! +Foam leverages VS Code and [[recommended-extensions]] to provide: + +- **Wikilinks** with autocomplete and navigation +- **Backlinks** panel showing connections +- **Graph visualization** of your knowledge network +- **Daily notes** with templates and snippets +- **Tag system** for organization +- **Publishing** to static sites ![Short video of Foam in use](assets/images/foam-navigation-demo.gif) -Head over to [[recipes]] for some useful patterns and ideas! +Explore [[recipes]] for usage patterns and workflows. -## Call To Adventure +## Contributing -The goal of **Foam** is to be your personal companion on your quest for knowledge. +Foam is an evolving project and we welcome contributions: -It's currently about "10% ready" relative to all the features I've thought of, but I've only thought of ~1% of the features it could have, and I'm excited to learn from others. - -I am using it as my personal thinking tool. By making it public, I hope to learn from others not only how to improve Foam, but also to improve how I learn and manage information. - -If that sounds like something you're interested in, I'd love to have you along on the journey. - -- Read about our [[principles]] to understand Foam's philosophy and direction -- Read the [[contribution-guide]] guide to learn how to participate. -- Feel free to open [GitHub issues](https://github.com/foambubble/foam/issues) to give me feedback and ideas for new features. +- Read our [[principles]] to understand Foam's philosophy +- Follow the [[contribution-guide]] to get involved +- Share feedback via [GitHub issues](https://github.com/foambubble/foam/issues) ## Thanks and attribution @@ -281,20 +287,18 @@ If that sounds like something you're interested in, I'd love to have you along o -**Foam** was inspired by [Roam Research](https://roamresearch.com/) and the [Zettelkasten methodology](https://zettelkasten.de/posts/overview) +Foam was inspired by [Roam Research](https://roamresearch.com/) and [Zettelkasten methodology](https://zettelkasten.de/posts/overview). -**Foam** wouldn't be possible without [Visual Studio Code](https://code.visualstudio.com/) and [GitHub](https://github.com/), and relies heavily on our fantastic open source [[recommended-extensions]] and all their contributors! +Foam builds on [Visual Studio Code](https://code.visualstudio.com/), [GitHub](https://github.com/), and our [[recommended-extensions]]. ## License Foam is licensed under the [MIT license](LICENSE.txt). -[//begin]: # "Autogenerated link references for markdown compatibility" -[graph-visualization]: user/features/graph-visualization.md "Graph Visualization" -[backlinking]: user/features/backlinking.md "Backlinking" -[recommended-extensions]: user/getting-started/recommended-extensions.md "Recommended Extensions" -[recipes]: user/recipes/recipes.md "Recipes" -[frequently-asked-questions]: user/frequently-asked-questions.md "Frequently Asked Questions" -[principles]: principles.md "Principles" -[contribution-guide]: dev/contribution-guide.md "Contribution Guide" -[//end]: # "Autogenerated link references" +[//begin]: # 'Autogenerated link references for markdown compatibility' +[recommended-extensions]: user/getting-started/recommended-extensions.md 'Recommended Extensions' +[recipes]: user/recipes/recipes.md 'Recipes' +[frequently-asked-questions]: user/frequently-asked-questions.md 'Frequently Asked Questions' +[principles]: principles.md 'Principles' +[contribution-guide]: dev/contribution-guide.md 'Contribution Guide' +[//end]: # 'Autogenerated link references' diff --git a/docs/reading-list.md b/docs/reading-list.md deleted file mode 100644 index e4ef15a8..00000000 --- a/docs/reading-list.md +++ /dev/null @@ -1,10 +0,0 @@ -# Reading list - -- [Zettelkasten article, recommended by tchayen](https://github.com/alefore/weblog/blob/master/zettelkasten.md) -- [Suping up VS Code as a Markdown editor](https://kortina.nyc/essays/suping-up-vs-code-as-a-markdown-notebook/) -- [VSCode Extensions Packs](https://code.visualstudio.com/blogs/2017/03/07/extension-pack-roundup) [[todo]] Evaluate for deployment -- [Dark mode](https://css-tricks.com/dark-modes-with-css/) - -[//begin]: # "Autogenerated link references for markdown compatibility" -[todo]: dev/todo.md "Todo" -[//end]: # "Autogenerated link references" diff --git a/docs/terminology.md b/docs/terminology.md deleted file mode 100644 index 36775d0c..00000000 --- a/docs/terminology.md +++ /dev/null @@ -1,19 +0,0 @@ -# Terminology - -It would be good to have some shared terminology to talk about Foam concepts. Some in-group terminology is acceptable, but we shouldn't be obtuse just to be exclusive. - -Here's some ideas, these are open for discussion. - -## Foam, the software project - -The set of tools and ideas collected in this organisation. - -## (Your) Foam - -The directory/repository where you keep all your notes. - -Also happens to sound quite a lot like Home. Funny, that. - -## Bubble - -Individual Foam note, written in Markdown. diff --git a/docs/user/__foam todo.md b/docs/user/__foam todo.md new file mode 100644 index 00000000..f4e421ca --- /dev/null +++ b/docs/user/__foam todo.md @@ -0,0 +1,6 @@ +- command to bootstrap workspace +- make all extensions ON for attachments by default +- improve settings description +- add deprecation to daily note settings in package.json +- JS filteres and hooks +- plugins (compatibility with Obsidian?) diff --git a/docs/user/features/backlinking.md b/docs/user/features/backlinking.md index 05efc60b..0887c518 100644 --- a/docs/user/features/backlinking.md +++ b/docs/user/features/backlinking.md @@ -1,16 +1,66 @@ -# Backlinking +# Backlinks -When using [[wikilinks]], you can find all notes that link to a specific note in the **Connections Explorer** +Backlinks are one of Foam's most powerful features for knowledge discovery. They automatically show you which notes reference your current note, creating a web of interconnected knowledge that reveals surprising relationships between your ideas. -- Run `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type "connections" and run the **Explorer: Focus on Connections** view. -- Keep this pane always visible to discover relationships between your thoughts -- You can drag the connections panel to a different section in VS Code if you prefer. See: [[make-backlinks-more-prominent]] -- You can filter the connections to see just backlinks, forward links, or all connections -- Finding backlinks in published Foam workspaces via [[materialized-backlinks]] is on the [[roadmap]] but not yet implemented. +_[📹 Watch: Understanding and using backlinks in Foam]_ -[//begin]: # "Autogenerated link references for markdown compatibility" -[wikilinks]: wikilinks.md "Wikilinks" -[make-backlinks-more-prominent]: ../recipes/make-backlinks-more-prominent.md "Make Backlinks More Prominent" -[materialized-backlinks]: ../../dev/proposals/materialized-backlinks.md "Materialized Backlinks (stub)" -[roadmap]: ../../dev/proposals/roadmap.md "Roadmap" -[//end]: # "Autogenerated link references" +## What Are Backlinks? + +A backlink is a connection from another note that points to the note you're currently viewing. While you create forward links intentionally with `[[wikilinks]]`, backlinks are discovered automatically by Foam. + +### Forward Links vs. Backlinks + +**Forward Links** (what you create): + +```markdown +# Machine Learning Note + +I'm studying [[Neural Networks]] and [[Deep Learning]] concepts. +``` + +**Backlinks** (what Foam discovers): +If you're viewing the "Neural Networks" note, Foam shows you that "Machine Learning Note" links to it, even though you didn't explicitly create that reverse connection. + +This bidirectional linking creates a richer knowledge network than traditional hierarchical folders. + +## Accessing Backlinks - Connections Panel + +The Connections panel shows both forward links and backlinks: + +1. **Open Command Palette** (`Ctrl+Shift+P` / `Cmd+Shift+P`) +2. **Type "connections"** and select "Explorer: Focus on Connections" +3. **Use the filter buttons** to show only backlinks, forward links, or all connections + +_[📹 Watch: Finding and opening the backlinks panel]_ + +## Using Backlinks for Knowledge Discovery + +### 1. Finding Unexpected Connections + +Backlinks often reveal relationships you didn't consciously create: + +**Example:** While reviewing a "Productivity" note, backlinks might show connections from: + +- A cooking recipe (time management for meal prep) +- A fitness routine (efficient workout planning) +- A work project (team productivity strategies) + +These diverse connections can spark new insights and cross-domain learning. + +### 2. Identifying Important Concepts + +Notes with many backlinks are often central to your thinking: + +- **Hub concepts** that connect many ideas +- **Frequently referenced** resources or definitions +- **Bridge topics** that span multiple domains + +### 3. Building Context Around Ideas + +Backlinks provide context for how you use concepts across different areas: + +- How you apply the same principle in various projects +- Evolution of your thinking about a topic over time +- Different perspectives you've encountered on the same idea + +_[📹 Watch: Using backlinks for knowledge discovery and research]_ diff --git a/docs/user/features/built-in-note-embedding-types.md b/docs/user/features/built-in-note-embedding-types.md deleted file mode 100644 index 64cd6e54..00000000 --- a/docs/user/features/built-in-note-embedding-types.md +++ /dev/null @@ -1,29 +0,0 @@ -# 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 `-