mirror of
https://github.com/foambubble/foam-template.git
synced 2025-06-07 20:08:54 +00:00
d9028e82fb
* 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
40 lines
2 KiB
Markdown
40 lines
2 KiB
Markdown
<img src="attachments/foam-icon.png" width=100 align="left">
|
|
|
|
# Foam
|
|
|
|
**👋 Welcome to your new Foam Knowledge Base!**
|
|
|
|
## Getting started
|
|
|
|
This documentation assumes that you have a GitHub account and have [Visual Studio Code](https://code.visualstudio.com/) installed on your Linux/MacOS/Windows machine.
|
|
|
|
1. If you haven't yet, browse over to the main [Foam documentation](https://foambubble.github.io/foam) to get an idea of what Foam is and how to use it.
|
|
2. Press "Use this template" button at [foam-template](https://github.com/foambubble/foam-template/generate) (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](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) 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](https://foambubble.github.io/foam/recipes/recipes) bubbles of the Foam documentation workspace.
|
|
|
|
And remember that you can always join our [Foam community on Discord](https://discord.gg/HV2tn2FpEk)!
|
|
|
|
## Using Foam
|
|
|
|
We've created a few Bubbles (markdown documents) to get you started.
|
|
|
|
- [[inbox]] - a place to write down quick notes to be categorized later
|
|
- [[getting-started]] - learn how to use your Foam workspace
|
|
- [[todo]] - a place to keep track of things to do
|
|
|
|
In the `docs` directory you can find everything you need to learn the basics of Foam.
|
|
|
|
|
|
[//begin]: # "Autogenerated link references for markdown compatibility"
|
|
[getting-started]: getting-started.md "Getting Started"
|
|
[inbox]: inbox.md "Inbox"
|
|
[todo]: todo.md "Todo"
|
|
[//end]: # "Autogenerated link references"
|