|
||
---|---|---|
.vscode | ||
_layouts | ||
assets/css | ||
getting-started.md | ||
inbox.md | ||
readme.md | ||
todo.md |
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.
-
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.
-
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.
-
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. -
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