Foam

What is Foam?

Foam is a personal knowledge management system built on Visual Studio Code and GitHub. It helps you organize research, create discoverable notes, and publish your knowledge.

Key Features

Why Choose Foam?

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!

Star Use this template

Table of Contents

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 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:

Features

Foam leverages VS Code and [recommended-extensions] to provide:

Short video of Foam in use

Explore [recipes] for usage patterns and workflows.

Contributing

Foam is an evolving project and we welcome contributions:

Thanks and attribution

Jani Eväkallio
Jani Eväkallio

💻 📖
Joe Previte
Joe Previte

💻 📖
Riccardo
Riccardo

💻 📖
Janne Ojanaho
Janne Ojanaho

💻 📖
Paul Shen
Paul Shen

📖
coffenbacher
coffenbacher

📖
Mathieu Dutour
Mathieu Dutour

📖
Michael Hansen
Michael Hansen

📖
David Nadlinger
David Nadlinger

📖
Fernando
Fernando

📖
Juan Gonzalez
Juan Gonzalez

📖
Louie Christie
Louie Christie

📖
Sandro
Sandro

📖
Simon Knott
Simon Knott

📖
Steven
Steven

📖
Tim
Tim

📖
Saurav Khdoolia
Saurav Khdoolia

📖
Ankit Tiwari
Ankit Tiwari

📖 ⚠️ 💻
Ayush Baweja
Ayush Baweja

📖
TaiChi-IO
TaiChi-IO

📖
Juan F Gonzalez
Juan F Gonzalez

📖
Sanket Dasgupta
Sanket Dasgupta

📖 💻
Nicholas Stafie
Nicholas Stafie

📖
Francis Hamel
Francis Hamel

💻
digiguru
digiguru

💻 📖
CHIRAG SINGHAL
CHIRAG SINGHAL

💻
Jonathan Carter
Jonathan Carter

📖
Julian Elve
Julian Elve

📖
Thomas Koppelaar
Thomas Koppelaar

💬 💻 📓
Akshay
Akshay

💻
John Lindquist
John Lindquist

📖
Ashwin Ramaswami
Ashwin Ramaswami

📖
Claudio Canales
Claudio Canales

📖
vitaly-pevgonen
vitaly-pevgonen

📖
Dmitry Shemetov
Dmitry Shemetov

📖
hooncp
hooncp

📖
Martin Laws
Martin Laws

📖
Sean K Smith
Sean K Smith

💻
Kevin Neely
Kevin Neely

📖
Arief Rahmansyah
Arief Rahmansyah

📖
Vishesh Handa
Vishesh Handa

📖
Hitesh Kumar
Hitesh Kumar

📖
Spencer Woo
Spencer Woo

📖
ingalless
ingalless

💻 📖
José Duarte
José Duarte

💻 📖
Yenly
Yenly

📖
hikerpig
hikerpig

💻
Sigfried Gold
Sigfried Gold

📖
Tristan Sokol
Tristan Sokol

💻
Danil Rodin
Danil Rodin

📖
Scott Williams
Scott Williams

📖
jackiexiao
jackiexiao

📖
John B Nelson
John B Nelson

📖
Asif Mehedi
Asif Mehedi

📖
Tan Li
Tan Li

💻
Shauna Gordon
Shauna Gordon

📖
Mike Cluck
Mike Cluck

💻
Brandon Pugh
Brandon Pugh

💻
Max Davitt
Max Davitt

📖
Brian Anglin
Brian Anglin

📖
elswork
elswork

📖
léon h
léon h

💻
Nikhil Nygaard
Nikhil Nygaard

📖
Mark Dixon
Mark Dixon

💻
Joel James
Joel James

💻
Hashiguchi Ryo
Hashiguchi Ryo

📖
Michael Overmeyer
Michael Overmeyer

💻
Derrick Qin
Derrick Qin

📖
Omar López
Omar López

📖
Robin King
Robin King

💻
Dheepak
Dheepak

📖
Daniel VG
Daniel VG

📖
Barabas
Barabas

💻
Engincan VESKE
Engincan VESKE

📖
Paul de Raaij
Paul de Raaij

💻
Scott Bronson
Scott Bronson

📖
Rafael Riedel
Rafael Riedel

📖
Pearcekieser
Pearcekieser

📖
Owen Young
Owen Young

📖 🖋
Prashanth Subrahmanyam
Prashanth Subrahmanyam

📖
Jonas SPRENGER
Jonas SPRENGER

💻
Paul
Paul

📖
Ikko Ashimine
Ikko Ashimine

📖
memeplex
memeplex

💻
AndreiD049
AndreiD049

💻
Yan
Yan

📖
Jim Tittsler
Jim Tittsler

📖
Malcolm Mielle
Malcolm Mielle

📖
Veesar
Veesar

📖
bentongxyz
bentongxyz

💻
Brian DeVries
Brian DeVries

💻
Clifford Fajardo
Clifford Fajardo

🔧
Chris Usick
Chris Usick

💻
Joe DeCock
Joe DeCock

💻
Drew Tyler
Drew Tyler

📖
Lauviah0622
Lauviah0622

💻
Josh Dover
Josh Dover

💻
Phil Helm
Phil Helm

📖
Larry Li
Larry Li

💻
Joe Taber
Joe Taber

📖
Woosuk Park
Woosuk Park

📖
Daniel Murphy
Daniel Murphy

💻
Dominic D
Dominic D

💻
luca
luca

📖
Lloyd Jackman
Lloyd Jackman

📖
sn3akiwhizper
sn3akiwhizper

📖
jonathan berger
jonathan berger

📖
Daniel Wang
Daniel Wang

💻
Liu YongLiang
Liu YongLiang

📖
Scott Akerman
Scott Akerman

💻
Jim Graham
Jim Graham

💻
Zhizhen He
Zhizhen He

🔧
Tony Cheneau
Tony Cheneau

📖
Nicholas Latham
Nicholas Latham

💻
Tomochika Hara
Tomochika Hara

📖
Daniel Carosone
Daniel Carosone

📖
Miguel Angel Bruni Montero
Miguel Angel Bruni Montero

💻
Kevin Walsh
Kevin Walsh

📖
Xinglan Liu
Xinglan Liu

💻
Thomas Hegghammer
Thomas Hegghammer

📖
Piotr Mrzygłosz
Piotr Mrzygłosz

📖
Mark Schaver
Mark Schaver

📖
Nathan Layman
Nathan Layman

💻
Emmanuel Ferdman
Emmanuel Ferdman

📖
Tenormis
Tenormis

💻
David Jones
David Jones

📖
S. Jacob Powell
S. Jacob Powell

💻
Davi Figueiredo
Davi Figueiredo

📖

Foam was inspired by Roam Research and Zettelkasten methodology.

Foam builds on Visual Studio Code, GitHub, and our [recommended-extensions].

License

Foam is licensed under the MIT license.