Writing Notes

Notes are simple text files with some extra flavor, in the shape of Markdown syntax and support for extra properties (see Note Properties).

Foam Syntax

Foam uses standard Markdown, with a few added twists:

  • the title of a note (e.g. in the Graph Visualization) is given by precedence based on:
    • the title property (see Note Properties)
    • the first # heading 1 of the file
    • the file name

Markdown Syntax

With Markdown, we can style our notes in a simple way, while keeping the document a simple text file (the best way to future-proof your writings!).

You can see the formatted output by running the Markdown: Open Preview to the Side command.

Here is a high level overview of Markdown, for more information on the Markdown syntax see here.

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

This is a link to google.

This is a wikilink (aka internal link) to Note Properties.

Here is an image: ![image](../../attachments/foam-icon.png)

this is a blockquote it can span multiple lines

  • list item
  • list item
  • list item
  • One
  • Two
  • Three

This text is in bold and this is italic.

The following is a horizontal rule


This is a table: | Column 1 | Column 2 | | –––– | –––– | | R1C1 | R1C2 | | R2C1 | R2C2 |

You can inline code or

you can create
code blocks
Links to this page
  • Note Properties
    the title property will assign the name to the note that you will see in the graph, regardless of the filename or the first heading (also see how to Writing Notes)