Skip to content

Generate a site using Gatsby#

Using foam-gatsby-template#

You can use foam-gatsby-template to generate a static site to host it online on GitHub or Vercel.

Publishing your foam to GitHub pages#

It comes configured with GitHub actions to auto deploy to GitHub pages when changes are pushed to your main branch.

Publishing your foam to Vercel#

When you're ready to publish, run a local build.

cd _layouts
npm run build

Remove public from your .gitignore file then commit and push your public folder in _layouts to GitHub.

Log into your Vercel account. (Create one if you don't have it already.)

Import your project. Select _layouts/public as your root directory and click Continue. Then name your project and click Deploy.

That's it!

Using foam-template-gatsby-kb#

You can use another template foam-template-gatsby-kb, and host it on Vercel or Netlify.

Using foam-template-gatsby-theme-primer-wiki#

You can use another template foam-template-gatsby-theme-primer-wiki, (Demo), and host it on Github Pages, Vercel or Netlify.