https://github.com/foambubble/foam-template

Foam workpace template
https://github.com/foambubble/foam-template

Last synced: 30 days ago
JSON representation

Foam workpace template

• Host: GitHub
• URL: https://github.com/foambubble/foam-template
• Owner: foambubble
• Created: 2020-06-19T23:41:55.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T12:07:37.000Z (about 2 months ago)
• Last Synced: 2024-10-01T18:23:37.701Z (about 1 month ago)
• Language: SCSS
• Size: 27.1 MB
• Stars: 1,044
• Watchers: 28
• Forks: 366
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• awesome-foam - Base Foam Template
• jimsghstars - foambubble/foam-template - Foam workpace template (SCSS)

README

        


# 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](./getting-started.md) to get familiar with your new knowledge base!

To learn more about how to use **Foam**, read the [Recipes](https://foambubble.github.io/foam/user/recipes/recipes) bubbles of the Foam documentation workspace.

And remember that you can always join our [Foam community on Discord](https://foambubble.github.io/join-discord/g)!

## Using Foam

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

- [inbox](./inbox.md) - a place to write down quick notes to be categorized later

- [getting-started](./getting-started.md) - learn how to use your Foam workspace

- [todo](./todo.md) - 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.

## Submitting Issues

As you may have noticed, issues are disabled. With the goal to keep the project fairly easy to maintain, please file your issues in the main Foam repository:

>