# What is Foam? 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. ## Key Features - **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!
## Table of Contents - [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) - [Contributing](#contributing) - [Thanks and attribution](#thanks-and-attribution) - [License](#license) ## How do I use Foam? Foam helps you create relationships between thoughts and information through: 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 Success with Foam depends on consistent note-taking and linking habits. ## What's in a Foam? Foam combines existing tools: 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 > This documentation was created using Foam. ## Getting started **Requirements:** GitHub account and Visual Studio Code 1. **Create repository** - Use the [foam-template](https://github.com/foambubble/foam-template) to generate a new repository 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 **Next steps:** - 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 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  Explore [[recipes]] for usage patterns and workflows. ## Contributing Foam is an evolving project and we welcome contributions: - 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