https://github.com/foambubble/foam

Markdown
A personal knowledge management and sharing system for VSCode

👋 Hello friend! Looks like you're reading this page on GitHub. Please go to the 👉rendered Foam Workspace for an improved experience!

👀This is an early stage project under rapid development. For updates follow @jevakallio on Twitter.

Foam

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.

How do I use Foam?

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 [[wiki-links]], 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].

Foam is a like a bathtub: What you get out of it depends on what you put into it.

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

• What's in a Foam?
• Getting started
• Features
• Call To Adventure
• Thanks and attribution

License

Foam is licensed under the MIT license.