foam-template/docs/how-to/write-notes-in-foam.md
Riccardo d9028e82fb
Added onboarding and major changes to template (#28)
* removed gitlens

* adjusted various settings

* added foam onboarding to template

* removed prettier extension

* added setting to match OS color scheme

* a couple of minor changes re todos and readme

* added spellright to list of recommended extensions, and added to getting started guide

* added reference to LTeX in spell checking doc

* Added logo to readme

* fixed link to LTeX extension

* styling logo in readme

* more style experiments
2021-01-22 13:17:24 +00:00

1.7 KiB

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 wiki link (aka internal link) to [note-properties].

Here is an image: image

this is a blockquote it can span multiple lines

  • list item
  • list item
  • list item
  1. One
  2. Two
  3. 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