docs/index.md
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.
[[double bracket]] syntax![[note]] syntaxFoam is like a bathtub: What you get out of it depends on what you put into it.
<p class="announcement"> <b>New!</b> Join <a href="https://foambubble.github.io/join-discord/w" target="_blank">Foam community Discord</a> for users and contributors! </p> <div class="website-only"> <a class="github-button" href="https://github.com/foambubble/foam" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star foambubble/foam on GitHub">Star</a> <a class="github-button" href="https://github.com/foambubble/foam-template" data-icon="octicon-repo-template" data-size="large" aria-label="Use this template foambubble/foam-template on GitHub">Use this template</a> </div>Foam helps you create relationships between thoughts and information through:
[[double bracket]] syntaxSuccess with Foam depends on consistent note-taking and linking habits.
Foam combines existing tools:
This documentation was created using Foam.
Requirements: GitHub account and Visual Studio Code
Create repository - Use the foam-template to generate a new repository
<a class="github-button" href="https://github.com/foambubble/foam-template/generate" data-icon="octicon-repo-template" data-size="large" aria-label="Use this template foambubble/foam-template on GitHub">Use this template</a>
Clone and open - Clone locally and open the folder in VS Code
Install extensions - Click "Install all" when prompted for recommended extensions
Configure - Edit .vscode/settings.json for your preferences
Next steps:
Foam leverages VS Code and [recommended-extensions] to provide:
Explore [recipes] for usage patterns and workflows.
Foam is an evolving project and we welcome contributions:
Foam was inspired by Zettelkasten methodology.
Foam builds on Visual Studio Code, GitHub, and our [recommended-extensions].
Foam is licensed under the MIT license.