# 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/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)! ## Github Pages In order to use Github Pages, rename your project name to `username.github.io` then go to `Settings` and from there select `Pages`, change source to `master` and save! Also you have to go to `Actions` tab and enable it, if you haven't. ## Docker Usage First, install docker using [this](https://docs.docker.com/get-docker/). ### Using Prebuilt Image (Dockerhub) If you don't want to build the image and just want to run the website using built image (Recommended): ```bash publish/dockerhub_run.sh ``` ### Build Docker image locally But if you want to to build your image locally, you can use ```bash publish/docker_build.sh ``` Then to run the image locally, use: ```bash publish/docker_run ``` ## 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: >