Skip to content

foambubble/foam

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Foam

👀This is an early stage project under rapid development. For updates join the Foam community Discord! 💬

All Contributors

Discord Chat

Foam is a personal knowledge management and sharing system inspired by Roam Research, built on Visual Studio Code and GitHub.

You can use Foam for organising your research, keeping re-discoverable notes, writing long-form content and, optionally, publishing it to the web.

Foam is free, open source, and extremely extensible to suit your personal workflow. You own the information you create with Foam, and you're free to share it, and collaborate on it with anyone you want.

Features

Graph Visualization

See how your notes are connected via a graph with the Foam: Show Graph command.

Graph Visualization

Link Autocompletion

Foam helps you create the connections between your notes, and your placeholders as well.

Link Autocompletion

Sync links on file rename

Foam updates the links to renamed files, so your notes stay consistent.

Sync links on file rename

Unique identifiers across directories

Foam supports files with the same name in multiple directories. It will use the minimum identifier required, and even report and help you fix existing ambiguous wikilinks.

Unique identifier autocompletion

Wikilink diagnostic

Link Preview and Navigation

Link Preview and Navigation

Go to definition, Peek References

See where a note is being referenced in your knowledge base.

Go to Definition, Peek References

Navigation in Preview

Navigate your rendered notes in the VS Code preview panel.

Navigation in Preview

Note embed

Embed the content from other notes.

Note Embed

Support for sections

Foam supports autocompletion, navigation, embedding and diagnostics for note sections. Just use the standard wiki syntax of [[resource#Section Title]].

Link Alias

Foam supports link aliasing, so you can have a [[wikilink]], or a [[wikilink|alias]].

Templates

Use custom templates to have avoid repetitve work on your notes.

Templates

Backlinks Panel

Quickly check which notes are referencing the currently active note. See for each occurrence the context in which it lives, as well as a preview of the note.

Backlinks Panel

Tag Explorer Panel

Tag your notes and navigate them with the Tag Explorer. Foam also supports hierarchical tags.

Tag Explorer Panel

Orphans and Placeholder Panels

Orphans are notes that have no inbound nor outbound links. Placeholders are dangling links, or notes without content. Keep them under control, and your knowledge base in a better state, by using this panel.

Orphans and Placeholder Panels

Syntax highlight

Foam highlights wikilinks and placeholder differently, to help you visualize your knowledge base.

Syntax Highlight

Daily note

Create a journal with daily notes.

Daily Note

Generate references for your wikilinks

Create markdown references for [[wikilinks]], to use your notes in a non-Foam workspace. With references you can also make your notes navigable both in GitHub UI as well as GitHub Pages.

Generate references

Commands

  • Explore your knowledge base with the Foam: Open Random Note command
  • Access your daily note with the Foam: Open Daily Note command
  • Create a new note with the Foam: Create New Note command
    • This becomes very powerful when combined with note templates and the Foam: Create New Note from Template command
  • See your workspace as a connected graph with the Foam: Show Graph command

Recipes

People use Foam in different ways for different use cases, check out the recipes page for inspiration!

Getting started

Whether you want to build a Second Brain or a Zettelkasten, write a book, or just get better at long-term learning, Foam can help you organise your thoughts if you follow these simple rules:

  1. Create a single Foam workspace for all your knowledge and research following the [[Getting started]] guide.
  2. Write your thoughts in markdown documents (I like to call them Bubbles, but that might be more than a little twee). These documents should be atomic: Put things that belong together into a single document, and limit its content to that single topic. (source)
  3. Use Foam's shortcuts and autocompletions to link your thoughts together with [[wikilinks]], and navigate between them to explore your knowledge graph.
  4. Get an overview of your Foam workspace using the [[Graph Visualisation]], and discover relationships between your thoughts with the use of [Backlinking].

You can also use our Foam template:

  1. Log in on your GitHub account.
  2. Create a GitHub repository from foam-template. If you want to keep your thoughts to yourself, remember to set the repository private.
  3. Clone the repository and open it in VS Code.
  4. When prompted to install recommended extensions, click Install all (or Show Recommendations if you want to review and install them one by one).

This will also install Foam, but if you already have it installed, that's ok, just make sure you're up to date on the latest version.

Requirements

High tolerance for alpha-grade software. Foam is still a Work in Progress. Rest assured it will never lock you in, nor compromise your files, but sometimes some features might break ;)

Known Issues

See the issues on our GitHub repo ;)

Release Notes

See the CHANGELOG.

Learn more

Head over to the 👉Published version of this Foam workspace to see Foam in action and read the rest of the documentation!

Quick links to next documentation sections

You can also browse the docs folder.

License

Foam is licensed under the MIT license.

Contributors

Thanks goes to these wonderful people (emoji key):

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

📖

This project follows the all-contributors specification. Contributions of any kind welcome!