https://github.com/ankeetmaini/foam-digital-garden
A ready to clone foam digital garden starter. Automatically deploys to Github Pages
https://github.com/ankeetmaini/foam-digital-garden
Last synced: 3 months ago
JSON representation
A ready to clone foam digital garden starter. Automatically deploys to Github Pages
- Host: GitHub
- URL: https://github.com/ankeetmaini/foam-digital-garden
- Owner: ankeetmaini
- License: mit
- Created: 2021-03-05T11:24:53.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-05T13:44:53.000Z (over 5 years ago)
- Last Synced: 2025-04-11T05:13:13.484Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://ankeetmaini.github.io/foam-digital-garden/
- Size: 1.02 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# foam-digital-garden-template
Create your notes and publish them digital-garden style effortlessely.
## adding notes
- start creating notes in the `content` directory
- read Foam's [documentation](https://foambubble.github.io/foam/) for backlinks and daily notes commands
## publishing using Github Action
- generate [personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token#creating-a-token) for the repo
- set it as a [secret](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with name `ACCESS_TOKEN`
> after these steps the site will be deployed automatically to Github pages on each push/commit on `main`
If you want to change the branch name, change it [here](./.github/workflows/publish.yaml)
## code syntax highlighting
### theme
- this template uses `okaidia` as the default prism theme
- if you wish to change it, please update [this line](https://github.com/ankeetmaini/foam-digital-garden/blob/main/src/gatsby-theme-garden/components/mdx-components/CodeBlock.js#L4)
### adding language syntaxes
- by default it covers most of the languages but if you want to add it
- import the prism modules [here as shown](https://github.com/ankeetmaini/foam-digital-garden/blob/main/src/gatsby-theme-garden/components/mdx-components/CodeBlock.js#L7)
## credits
- Gatsby starter for Digital Garden - https://github.com/mathieudutour/gatsby-starter-digital-garden
- Foam official template - https://github.com/foambubble/foam-template