homefoam/docs/publishing/publish-to-github-pages.md

GitHub Pages

1. In VSCode workspace settings set "foam.edit.linkReferenceDefinitions": "withoutExtensions"
2. Execute the “Foam: Run Janitor” command from the command palette.
3. Turn GitHub Pages on in your repository settings.
   • The default GitHub Pages template is called Primer. See Primer docs for how to customise html layouts and templates.
   • GitHub Pages is built on Jekyll, so it supports things like permalinks, front matter metadata etc.

How to publish locally

If you want to test your published foam, follow the instructions:

• https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll
• https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll

Assuming you have installed ruby/jekyll and the rest:

• touch Gemfile
  • open the file and paste the following:

source 'https://rubygems.org'

gem "github-pages", "VERSION"

replacing VERSION with the latest from https://rubygems.org/gems/github-pages (e.g. gem "github-pages", "209")

• bundle
• bundle exec jekyll 3.9.0 new .
• edit the Gemfile according to the instructions at Creating Your Site Point n.8
• bundle exec jekyll serve

Other templates

There are many other templates which also support publish your foam workspace to github pages

• gatsby-digital-garden
  • repo
  • demo-website
• foam-mkdocs-template
  • repo
  • demo-website
• foam-jekyll-template
  • repo
  • demo-website

todo good-first-task Improve this documentation