makary/foam-template
Template
1
0
Fork 0
mirror of https://github.com/foambubble/foam-template.git synced 2025-06-07 11:58:53 +00:00
Code Issues Projects Releases Packages Wiki Activity
foam-template/getting-started.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

3.6 KiB
Raw Blame History

Getting Started

Welcome to your new foam workspace, let's get you started.

if you are already familiar with Foam and don't need help, just remove the docs folder for a clean repo.

Let's go through this to set up your repo:

  • if you are new with VsCode, see how to [get-started-with-vscode] and how to [use-keyboard-shortcuts-for-editing]

  • you can navigate the links between your notes by cmd+click (or ctrl+click on Windows) on a wiki link. You can go back with ctrl+-. Here, go to your [inbox]

  • to see how your notes are connected, execute the Foam: Show Graph command. See [graph-visualization].

  • #tags can be used to further organize your content. Look at the Tag Explorer view on the left panel to find and navigate the tags in your knowledge base. See [tags-and-tag-explorer].

  • Foam supports [spell-checking].

  • You can also paste images in your Foam, just press cmd+alt+v to create the image file and link to it from your note. See [paste-images-from-clipboard].

  • You can use Foam for your daily notes, or journaling. Execute now the Foam: Open Daily Note command to create a new file in your journal folder. See [daily-notes].

  • Want to see how to manage your tasks? Go to the [todo] note

  • The section at the end of this file contains wikilink definitions, which enable navigation of your notes from GitHub's web UI, and in general to make [[wikilinks]] understood by any markdown parser. See [link-reference-definitions].

  • To explore all the Foam settings, press cmd+,, then Extensions > Foam

  • Living within VsCode, Foam can be customized in many ways! Look at the Foam Recipes for ideas!

  • Join the Foam community on Discord, introduce yourself and leave a message on how you found Foam and how the onboarding went :) We are always keen to do better

Advanced Features

  • You can create [note-templates] for things like book reviews, people, daily notes (coming soon), and more!

About Foam

Foam doesn't do all this magic on its own, it relies on some amazing extensions. Look at their documentation if you want to fully unlock the possibilities!

Here they are:

A special mention to Markdown Links, which has now been replaced by our graph but was foundational to Foam's beginnings.