| .foam/templates | ||
| .github/workflows | ||
| .vscode | ||
| _layouts | ||
| assets/css | ||
| attachments | ||
| docs | ||
| publish | ||
| .gitignore | ||
| _config.yml | ||
| Gemfile | ||
| 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.
And remember that you can always join our Foam community on Discord!
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.
Using Prebuilt Image (Dockerhub)
If you don't want to build the image and just want to run the website using built image (Recommended):
publish/dockerhub_run.sh
Build Docker image locally
But if you want to to build your image locally, you can use
publish/docker_build.sh
Then to run the image locally, use:
publish/docker_run
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.
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: