# Github Pages

- The [Foam template](https://github.com/foambubble/foam-template) is **GitHub Pages** ready, all you have to do is [turn it on in your repository settings](https://guides.github.com/features/pages/).
- The default GitHub Pages template is called [Primer](https://github.com/pages-themes/primer). See Primer docs for how to customise html layouts and templates.
- GitHub Pages is built on [Jekyll](https://jekyllrb.com/), so it supports things like permalinks, front matter metadata etc.

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

* gatsby-digital-garden
    * [repo](https://github.com/mathieudutour/gatsby-digital-garden)
    * [demo-website](https://mathieudutour.github.io/gatsby-digital-garden/)
* foam-mkdocs-template
    * [repo](https://github.com/Jackiexiao/foam-mkdocs-template)
    * [demo-website](https://jackiexiao.github.io/foam/)
* foam-jekyll-template
    * [repo](https://github.com/hikerpig/foam-jekyll-template)
    * [demo-website](https://wiki.hikerpig.cn/)

[[todo]] [[good-first-task]] Improve this documentation

[//begin]: # "Autogenerated link references for markdown compatibility"
[todo]: todo.md "Todo"
[good-first-task]: good-first-task.md "Good First Task"
[//end]: # "Autogenerated link references"