Skip to main content

📦 Deploying the workshop

Building/testing it​

npm start builds a development version of the Docusaurus workshop. To build the production version locally we should use npm run build that also checks links.

It will create a build directory. This is a generated static version of the workshop we can host anywhere. This directory is ignored by git.

The Search Box plugin only works with a production build. So: run a npm run build before pushing your changes to the repo.

Make your repo public​

  • to be able to use GH Pages, the repo has to be public
    • Login into your GH account using 2FA as you'll need to be logged in during this setup
    • if it's private go to repo settings > Danger Zone > Change repository visibility and make it public.

Github Actions​

In ./github/workflows there's a Github action to automatically deploy this site in Github pages. You just need to push changes to main and everything should happen automagically.