Skip to content

Installation

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

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

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 Using Foam with VS Code Features

The Foam extension adds knowledge management superpowers to VS Code.

  1. Open VS Code
  2. Click the Extensions icon in the sidebar (or press Ctrl+Shift+X / Cmd+Shift+X)
  3. Search for “Foam” in the extensions marketplace
  4. Click “Install” on the official Foam extension by Foam Team
  5. Reload VS Code when prompted
  • Wikilink auto-completion and navigation
  • Backlink discovery and panel
  • Graph visualization
  • Powerful note template engine
  • Daily notes functionality

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 functionality of your notes.

  • 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

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

  1. Creating Your First Workspace - Set up your knowledge base structure
  2. Using Foam with VS Code Features - Learn how to use VS Code for note taking
  3. Note-Taking in Foam - Write your first Markdown notes
  4. Navigation in Foam - Connect your thoughts with wikilinks
  5. Graph Visualization - Visualize your knowledge network

If you encounter issues:

Published with Foam