foam/docs/user/index.md

Using Foam

Foam is a collection VS Code extensions and recipes that power up the editor into a full-blown note taking system. This folder contains user documentation describing how to get started using Foam, what its main features are, and strategies for getting the most out of Foam. The full docs are included in the foam-template repo that most users start from.

See also [frequently-asked-questions].

Getting Started

• [get-started-with-vscode]
• [recommended-extensions]
• [creating-new-notes]
• [write-notes-in-foam]
• [sync-notes-with-soruce-control]
• [keyboard-shortcuts]

Features

• [wikilinks]
• [tags]
• [backlinking]
• [daily-notes]
• [including-notes]
• [spell-checking]
• [graph-visualization]
• [note-properties]
• [note-templates]
• [paste-images-from-clipboard]
• [custom-markdown-preview-styles]
• [link-reference-definitions]
• [custom-snippets]

Recipes

[recipes] is a collection of user-contributed patterns that describe different ways you could utilize Foam or integrate it with other tools.

Publishing

You can publish your Foam notes for consumption in different formats. Examples: [publish-to-github-pages], [generate-gatsby-site], [publish-to-vercel]

See [publishing] for more details.

Tools

• [cli]
• [workspace-janitor]
• [orphans]
• [foam-logging-in-vscode]