How do I publish my Foam notes to a website?

Foam supports publishing to the web via GitHub Pages. You can generate markdown references for wikilinks to make notes navigable in GitHub UI and deploy them as a static site using the included templates.

Foam vs Obsidian: which is better for developers?

Foam is ideal for VS Code users who want deep editor integration and Git-based workflows, while Obsidian offers a polished standalone app with more themes and plugins but less customization for developer-centric tools.

How to set up daily notes in Foam?

Use the 'Foam: Open Daily Note' command to create journal entries. You can customize templates for consistent formatting through the templates feature, which automates repetitive note structures.

Can Foam sync notes across multiple devices?

Yes, by using Git to sync your Foam workspace repository. However, it requires manual commits and pushes, unlike cloud-synced services, so it's better for users comfortable with version control.

Is Foam good for team documentation wikis?

It can be used for team wikis via Git collaboration, but lacks real-time editing features. It's best for asynchronous work where members are okay with merge conflicts and manual syncing.

How to migrate from Roam Research to Foam?

Export your Roam notes to markdown format and import them into a Foam workspace. Foam uses similar wikilink syntax, but some Roam-specific features like block references may require manual adjustment.

Open-Awesome

foam

NOASSERTIONTypeScriptvscode@0.40.4

A personal knowledge management and sharing system for VSCode, inspired by Roam Research.

Visit Website GitHub

17.3k stars772 forks0 contributors

What is foam?

Foam is a personal knowledge management and sharing system built as a Visual Studio Code extension. It helps users organize their thoughts, research, and notes using a graph-based approach with wikilinks, inspired by Roam Research. It enables non-linear thinking, connection of ideas, and long-form writing while keeping data in markdown files that can be version-controlled with Git.

Target Audience

Developers, researchers, writers, and knowledge workers who already use VS Code and want a connected note-taking system without leaving their editor. It's ideal for those building a Second Brain, Zettelkasten, or personal wiki.

Value Proposition

Foam provides a free, open-source alternative to commercial knowledge management tools, with deep integration into VS Code and Git. Users own their data, avoid vendor lock-in, and can extend the system to fit their personal workflow.

Overview

A personal knowledge management and sharing system for VSCode

Use Cases

Best For

Building a personal knowledge base with interconnected notes
Creating a Zettelkasten or Second Brain system
Writing long-form content like books or research papers
Maintaining a developer wiki or project documentation
Journaling with daily notes and templates
Organizing academic research with backlinks and graph visualization

Not Ideal For

Teams requiring real-time collaborative editing with live updates
Users who primarily take notes on mobile or web without VS Code access
Projects needing rich multimedia embedding beyond markdown images and links
Those seeking a polished, stable out-of-the-box solution with no setup friction

Pros & Cons

Pros

Interactive Graph Visualization

Foam provides a live graph view of connected notes with the 'Foam: Show Graph' command, enabling users to visually explore relationships between ideas non-linearly.

Automatic Link Management

It syncs wikilinks when files are renamed and offers autocompletion for placeholders, reducing manual maintenance and ensuring note consistency across the workspace.

Deep VS Code Integration

As a VS Code extension, Foam leverages the editor's ecosystem for editing, extensions, and Git version control, making it seamless for developers already in that environment.

Data Ownership and Portability

Notes are stored in plain markdown files, free from vendor lock-in, and can be easily shared, version-controlled with Git, or published to the web via GitHub Pages.

Cons

Alpha Software Stability

The README explicitly warns it requires 'high tolerance for alpha-grade software' and features might break, as it's still a Work in Progress with known issues.

Dependent on VS Code

Foam is tied to Visual Studio Code, limiting its use for those who prefer other editors or need mobile access, as it doesn't have standalone apps.

Git-Centric Workflow Complexity

Effective use relies on Git for version control and collaboration, which may be a barrier for non-developers or teams unfamiliar with Git workflows.

Open Source Alternative To

foam is an open-source alternative to the following products:

Roam Research

Roam Research is a note-taking and knowledge management application that uses a graph database to create bidirectional links between notes for networked thought.

Frequently Asked Questions

Related Projects

Excalidraw

Virtual whiteboard for sketching hand-drawn like diagrams

Stars128,238

Forks14,535

Last commit23 hours ago

tesseract

Tesseract Open Source OCR Engine (main repository)

Universal markup converter

Stars45,536

Forks3,921

Last commit22 hours ago

carbon

:black_heart: Create and share beautiful images of your source code

Stars36,062

Forks1,977

Last commit5 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub