Foam
T
Foam

    Wiki Links

    Foam enables you to Link pages together using [[file-name]] annotations (i.e. [[media-wiki]] links).

    • Type [[ and start typing a file name for autocompletion.
      • Note that your file names should be in lower-dash-case.md, and your wiki links should reference file names exactly: [[lower-dash-case]], not [[Lower Dash Case]].
      • See [[link-formatting-and-autocompletion]] for more information, and how to setup your link autocompletions to make this easier.
    • Cmd + Click ( Ctrl + Click on Windows ) on file name to navigate to file (F12 also works while your cursor is on the file name)
    • Cmd + Click ( Ctrl + Click on Windows ) on non-existent file to create that file in the workspace.

    If the F12 shortcut feels unnatural you can rebind it at File > Preferences > Keyboard Shortcuts by searching for editor.action.revealDefinition.

    Markdown compatibility

    The Foam for VSCode extension automatically generates [[link-reference-definitions]] at the bottom of the file to make wiki-links compatible with Markdown tools and parsers.

    Read more

    Foam File Format
    This file is an example of a valid Foam file. Essentially it's just a markdown file with a bit of additional support for mediawiki-style `[[wiki-links]]`.
    Foam File Format
    Here are a few specific constraints, mainly because our tooling is a bit fragmented. Most of these should be eventually lifted, and our requirement should just be "Markdown with `[[wiki-links]]`:
    Foam File Format
    - **In addition to normal Markdown Links syntax you can use `[[media-wiki]]` links.** See [[wiki-links]] for more details.
    Frequently Asked Questions
    - Check the formatting rules for links on [[foam-file-format]], [[wiki-links]] and [[link-formatting-and-autocompletion]]
    Foam
    3. Use Foam's shortcuts and autocompletions to link your thoughts together with `[[wiki-links]]`, and navigate between them to explore your knowledge graph.
    Roadmap
    - Fix [[wiki-links]] compatibility issues
    Backlinking
    When using [[wiki-links]], you can find all notes that link to a specific note in the [VS Code Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) **Backlinks Explorer**
    Recipes
    - Link documents with [[wiki-links]].
    Link Reference Definition Improvements
    For the time being, if you want to get [[wiki-links]] into all files within the workspace, you'll need to generate the link reference definitions yourself file-by-file (with the assistance of Foam).
    Foam Core
    - Can be either [[wiki-links]] or relative `[markdown](links.md)` style
    Foam Core
    - [[link-reference-definitions]] for [[wiki-links]]
    Link Reference Definitions
    When you use `[[wiki-links]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension will automatically generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file. This is done to make the content of the file compatible with various Markdown tools (e.g. parsers, static site generators, VS code plugins etc), which don't support `[[wiki-links]]`.
    Link Reference Definitions
    When you use `[[wiki-links]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension will automatically generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file. This is done to make the content of the file compatible with various Markdown tools (e.g. parsers, static site generators, VS code plugins etc), which don't support `[[wiki-links]]`.
    Show Graph Visualisation