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.
Foam is a tool that supports creating relationships between thoughts and information to help you think better.
[[wiki-links]], and navigate between them to explore your knowledge graph.
Foam is a like a bathtub: What you get out of it depends on what you put into it.
Like the soapy suds it’s named after, Foam is mostly air.
Fun fact: This documentation was researched, written and published using Foam.
⚠️ Foam is still in preview. Expect the experience to be a little rough.
These instructions assume you have a GitHub account, and you have Visual Studio Code installed.
Use the foam-template project to generate a new repository. If you’re logged into GitHub, you can just hit this button:
(If you want to keep your thoughts to yourself, remember to set the repository private, or if you don’t want to use GitHub to host your workspace at all, choose Download as ZIP instead of Use this template.)
Clone the repository locally and open it in VS Code.
When prompted to install recommended extensions, click Install all (or Show Recommendations if you want to review and install them one by one)
After setting up the repository, open
.vscode/settings.json and edit, add or remove any settings you’d like for your Foam workspace.
To learn more about how to use Foam, read the [recipes].
Foam doesn’t have features in the traditional sense. Out of the box, you have access to all features of VS Code and all the [recommended-extensions] you choose to install, but it’s up to you to discover what you can do with it!
Head over to [recipes] for some useful patterns and ideas!
The goal of Foam is to be your personal companion on your quest for knowledge.
It’s is currently about “10% ready” relative to all the features I’ve thought of, but I’ve only thought of ~1% of the features it could have, and I’m excited to learn from others.
I am using it as my personal thinking tool. By making it public, I hope to learn from others not only how to improve Foam, but also to improve how I learn and manage information.
If that sounds like something you’re interested in, I’d love to have you along on the journey.
Foam is licensed under the MIT license.