Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://foambubble.github.io/foam/

A personal knowledge management and sharing system for VSCode
https://foambubble.github.io/foam/
graph-visualisation markdown markdown-editor note-taking notes-app personal-knowledge-base pkm vscode zettelkasten
Last synced: 3 months ago
JSON representation
A personal knowledge management and sharing system for VSCode
Host: GitHub
URL: https://foambubble.github.io/foam/
Owner: foambubble
License: other
Created: 2020-06-19T17:04:10.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-04-11T06:24:36.000Z (7 months ago)
Last Synced: 2024-04-13T21:34:29.549Z (7 months ago)
Topics: graph-visualisation, markdown, markdown-editor, note-taking, notes-app, personal-knowledge-base, pkm, vscode, zettelkasten
Language: TypeScript
Homepage: https://foambubble.github.io/
Size: 57.7 MB
Stars: 14,778
Watchers: 121
Forks: 634
Open Issues: 97
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project

awesome-foam - Foam Homepage
awesome-fe-resources - Foam
README

        

# Foam

👀*This is an early stage project under rapid development. For updates join the [Foam community Discord](https://foambubble.github.io/join-discord/g)! 💬*

[![All Contributors](https://img.shields.io/badge/all_contributors-119-orange.svg?style=flat-square)](#contributors-)

[![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/foam.foam-vscode?label=VS%20Code%20Installs)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)

[![Discord Chat](https://img.shields.io/discord/729975036148056075?color=748AD9&label=discord%20chat&style=flat-square)](https://foambubble.github.io/join-discord/g)

**Foam** is a personal knowledge management and sharing system inspired by [Roam Research](https://roamresearch.com/), built on [Visual Studio Code](https://code.visualstudio.com/) and [GitHub](https://github.com/).

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](https://foambubble.github.io/foam/user/features/graph-visualization) with the `Foam: Show Graph` command.

![Graph Visualization](./assets/screenshots/feature-show-graph.gif)

### Link Autocompletion

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

![Link Autocompletion](./assets/screenshots/feature-link-autocompletion.gif)

### Sync links on file rename

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

![Sync links on file rename](./assets/screenshots/feature-link-sync.gif)

### 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](./assets/screenshots/feature-unique-wikilink-completion.gif)

![Wikilink diagnostic](./assets/screenshots/feature-wikilink-diagnostics.gif)

### Link Preview and Navigation

![Link Preview and Navigation](./assets/screenshots/feature-navigation.gif)

### Go to definition, Peek References

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

![Go to Definition, Peek References](./assets/screenshots/feature-definition-references.gif)

### Navigation in Preview

Navigate your rendered notes in the VS Code preview panel.

![Navigation in Preview](./assets/screenshots/feature-preview-navigation.gif)

### Note embed

Embed the content from other notes.

![Note Embed](./assets/screenshots/feature-note-embed.gif)

### 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](https://foambubble.github.io/foam/user/features/note-templates) to have avoid repetitve work on your notes.

![Templates](./assets/screenshots/feature-templates.gif)

### 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](./assets/screenshots/feature-backlinks-panel.gif)

### Tag Explorer Panel

Tag your notes and navigate them with the [Tag Explorer](https://foambubble.github.io/foam/user/features/tags).

Foam also supports hierarchical tags.

![Tag Explorer Panel](./assets/screenshots/feature-tags-panel.gif)

### 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](./assets/screenshots/feature-placeholder-orphan-panel.gif)

### Syntax highlight

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

![Syntax Highlight](./assets/screenshots/feature-syntax-highlight.png)

### Daily note

Create a journal with [daily notes](https://foambubble.github.io/foam/user/features/daily-notes).

![Daily Note](./assets/screenshots/feature-daily-note.gif)

### Generate references for your wikilinks

Create markdown [references](https://foambubble.github.io/foam/user/features/link-reference-definitions) 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](./assets/screenshots/feature-definitions-generation.gif)

### 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](https://foambubble.github.io/foam/user/features/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](https://foambubble.github.io/foam/user/recipes/recipes) page for inspiration!

## Getting started

Whether you want to build a [Second Brain](https://www.buildingasecondbrain.com/) or a [Zettelkasten](https://zettelkasten.de/posts/overview/), 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](https://zettelkasten.de/posts/overview/#principles))

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](https://github.com/foambubble/foam-template/generate). 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](https://github.com/foambubble/foam/issues/) on our GitHub repo ;)

## Release Notes

See the [CHANGELOG](./packages/foam-vscode/CHANGELOG.md).

## Learn more

**Head over to the 👉[Published version of this Foam workspace](https://foambubble.github.io/foam#whats-in-a-foam)** to see Foam in action and read the rest of the documentation!

Quick links to next documentation sections

- [What's in a Foam?](https://foambubble.github.io/foam#whats-in-a-foam)

- [Getting started](https://foambubble.github.io/foam#getting-started)

- [Features](https://foambubble.github.io/foam#features)

- [Call To Adventure](https://foambubble.github.io/foam#call-to-adventure)

- [Thanks and attribution](https://foambubble.github.io/foam#thanks-and-attribution)

You can also browse the [docs folder](https://github.com/foambubble/foam/tree/master/docs).

## License

Foam is licensed under the [MIT license](LICENSE).

[//begin]: # "Autogenerated link references for markdown compatibility"

[Backlinking]: docs/user/features/backlinking.md "Backlinking"

[//end]: # "Autogenerated link references"

## Contribution Guide

See the [Contribution Guide](https://foambubble.github.io/foam/dev/contribution-guide)

## Code of conduct

See the [Code of Conduct](https://foambubble.github.io/foam/dev/code-of-conduct)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_{Jani Eväkallio}
💻 📖

      
_{Joe Previte}
💻 📖

      
_Riccardo
💻 📖

      
_{Janne Ojanaho}
💻 📖

      
_{Paul Shen}
📖

      
_coffenbacher
📖

      
_{Mathieu Dutour}
📖

    

    

      
_{Michael Hansen}
📖

      
_{David Nadlinger}
📖

      
_Fernando
📖

      
_{Juan Gonzalez}
📖

      
_{Louie Christie}
📖

      
_Sandro
📖

      
_{Simon Knott}
📖

    

    

      
_Steven
📖

      
_Tim
📖

      
_{Saurav Khdoolia}
📖

      
_{Ankit Tiwari}
📖 ⚠️ 💻

      
_{Ayush Baweja}
📖

      
_TaiChi-IO
📖

      
_{Juan F Gonzalez}
📖

    

    

      
_{Sanket Dasgupta}
📖 💻

      
_{Nicholas Stafie}
📖

      
_{Francis Hamel}
💻

      
_digiguru
💻 📖

      
_{CHIRAG SINGHAL}
💻

      
_{Jonathan Carter}
📖

      
_{Julian Elve}
📖

    

    

      
_{Thomas Koppelaar}
💬 💻 📓

      
_Akshay
💻

      
_{John Lindquist}
📖

      
_{Ashwin Ramaswami}
📖

      
_{Claudio Canales}
📖

      
_{vitaly-pevgonen}
📖

      
_{Dmitry Shemetov}
📖

    

    

      
_hooncp
📖

      
_{Martin Laws}
📖

      
_{Sean K Smith}
💻

      
_{Kevin Neely}
📖

      
_{Arief Rahmansyah}
📖

      
_{Vishesh Handa}
📖

      
_{Hitesh Kumar}
📖

    

    

      
_{Spencer Woo}
📖

      
_ingalless
💻 📖

      
_{José Duarte}
💻 📖

      
_Yenly
📖

      
_hikerpig
💻

      
_{Sigfried Gold}
📖

      
_{Tristan Sokol}
💻

    

    

      
_{Danil Rodin}
📖

      
_{Scott Williams}
📖

      
_jackiexiao
📖

      
_{John B Nelson}
📖

      
_{Asif Mehedi}
📖

      
_{Tan Li}
💻

      
_{Shauna Gordon}
📖

    

    

      
_{Mike Cluck}
💻

      
_{Brandon Pugh}
💻

      
_{Max Davitt}
📖

      
_{Brian Anglin}
📖

      
_elswork
📖

      
_{léon h}
💻

      
_{Nikhil Nygaard}
📖

    

    

      
_{Mark Dixon}
💻

      
_{Joel James}
💻

      
_{Hashiguchi Ryo}
📖

      
_{Michael Overmeyer}
💻

      
_{Derrick Qin}
📖

      
_{Omar López}
📖

      
_{Robin King}
💻

    

    

      
_Dheepak
📖

      
_{Daniel VG}
📖

      
_Barabas
💻

      
_{Engincan VESKE}
📖

      
_{Paul de Raaij}
💻

      
_{Scott Bronson}
📖

      
_{Rafael Riedel}
📖

    

    

      
_Pearcekieser
📖

      
_{Owen Young}
📖 🖋

      
_{Prashanth Subrahmanyam}
📖

      
_{Jonas SPRENGER}
💻

      
_Paul
📖

      
_{Ikko Ashimine}
📖

      
_memeplex
💻

    

    

      
_AndreiD049
💻

      
_Yan
📖

      
_{Jim Tittsler}
📖

      
_{Malcolm Mielle}
📖

      
_Veesar
📖

      
_bentongxyz
💻

      
_{Brian DeVries}
💻

    

    

      
_{Clifford Fajardo}
🔧

      
_{Chris Usick}
💻

      
_{Joe DeCock}
💻

      
_{Drew Tyler}
📖

      
_Lauviah0622
💻

      
_{Josh Dover}
💻

      
_{Phil Helm}
📖

    

    

      
_{Larry Li}
💻

      
_{Joe Taber}
📖

      
_{Woosuk Park}
📖

      
_{Daniel Murphy}
💻

      
_{Dominic D}
💻

      
_luca
📖

      
_{Lloyd Jackman}
📖

    

    

      
_{sn3akiwhizper}
📖

      
_{jonathan berger}
📖

      
_{Daniel Wang}
💻

      
_{Liu YongLiang}
📖

      
_{Scott Akerman}
💻

      
_{Jim Graham}
💻

      
_{Zhizhen He}
🔧

    

    

      
_{Tony Cheneau}
📖

      
_{Nicholas Latham}
💻

      
_{Tomochika Hara}
📖

      
_{Daniel Carosone}
📖

      
_{Miguel Angel Bruni Montero}
💻

      
_{Kevin Walsh}
📖

      
_{Xinglan Liu}
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!