Installation

Getting started with Foam is straightforward. This guide will walk you through installing everything you need to begin your knowledge management journey.

Step 1: Install Visual Studio Code

Foam is built on VS Code, Microsoft's free, open-source code editor. You can download it at https://code.visualstudio.com/

Why VS Code?

VS Code provides:

Excellent Markdown editing capabilities
Rich extension ecosystem
Cross-platform compatibility
Integrated terminal and Git support
Customizable interface and shortcuts

To learn more about using VS Code with Foam, check [get-started-with-vscode]

Step 2: Install the Foam Extension

The Foam extension adds knowledge management superpowers to VS Code.

Open VS Code
Click the Extensions icon in the sidebar (or press Ctrl+Shift+X / Cmd+Shift+X)
Search for "Foam" in the extensions marketplace
Click "Install" on the official Foam extension by Foam Team
Reload VS Code when prompted

What the Foam Extension Provides

Wikilink auto-completion and navigation
Backlink discovery and panel
Graph visualization
Powerful note template engine
Daily notes functionality

Step 3: Install Recommended Extensions

While Foam works on its own, it is focused on the networking aspect of your notes. You might want to install additional extensions to improve the editing experience or the functionility of your notes.

Useful Extensions

Markdown All in One - Rich Markdown editing features. Highly recommended.

Other extensions:

Spell Right - Spell checking for your notes
Paste Image - Easily insert images from clipboard
Todo Tree - Track TODO items across your workspace

What's Next?

Now that Foam is installed, you're ready to:

[first-workspace] - Set up your knowledge base structure
[get-started-with-vscode] - Learn how to use VS Code for note taking
[note-taking-in-foam] - Write your first Markdown notes
[navigation] - Connect your thoughts with wikilinks
[graph-view] - Visualize your knowledge network

Getting Help

If you encounter issues:

Check the [frequently-asked-questions] for common problems
Visit the Foam Community Discord
Browse GitHub Issues for known problems
Ask questions in GitHub Discussions

3.0 KiB Raw Blame History