Foam workpace template
Find a file Use this template
Riccardo Ferretti 991970ff2c added prettier.singleQuote=false setting (see issue foambubble/foam#94)
this way avoid prettier interfering with defiinition generation
2021-01-06 22:59:15 +01:00
.vscode added prettier.singleQuote=false setting (see issue foambubble/foam#94) 2021-01-06 22:59:15 +01:00
_layouts Add accessible display links 2020-06-25 16:37:36 +01:00
assets/css Basic CSS for published Foam 2020-06-20 02:27:50 +01:00
getting-started.md added a getting started guide, and some settings defaults 2021-01-05 23:31:18 +01:00
inbox.md added a getting started guide, and some settings defaults 2021-01-05 23:31:18 +01:00
readme.md added a getting started guide, and some settings defaults 2021-01-05 23:31:18 +01:00
todo.md Update links and references 2020-06-25 23:16:37 +01:00

Foam

👋 Welcome to your new Foam Knowledge Base!

Getting started

This documentation assumes that you have a GitHub account and have Visual Studio Code installed on your Linux/MacOS/Windows machine.

  1. If you haven't yet, browse over to the main Foam documentation to get an idea of what Foam is and how to use it.

  2. Press "Use this template" button at foam-template (that's this repository!) to fork it to your own GitHub account. If you want to keep your thoughts to yourself, remember to set the repository private.

  3. Clone the repository to your local machine and open it in VS Code.

    Open the repository as a folder using the File > Open... menu item.

  4. When prompted to install recommended extensions, click Install all (or Show Recommendations if you want to review and install them one by one)

After setting up the repository, head to [getting-started] to get familiar with your new knowledge base!

To learn more about how to use Foam, read the Recipes bubbles of the Foam documentation workspace.

Using Foam

We've created a few Bubbles (markdown documents) to get you started.

  • [inbox] - a place to write down quick notes to be categorised later
  • [getting-started] - learn how to use your Foam workspace
  • [todo] - a place to keep track of things to do