Getting started

Please follow following steps to use the theme.

1. Use template or fork the example repository

Go to the example repository. Click on the Use this template button or the Fork on the top right, to create a new repository with this template.

The example repository repo should demonstrate how easy it is to setup the theme, but more importantly, to show how small the footprint is of the theme. It is the bare minimal to start if you want to use the theme. This way of using the theme will also make sure that your own content is not cluttered with theme files and that you can easily stay up to date when improvements to the theme are made.

2. Select and pin a theme version

Before the first deployment, select a version from the theme releases, read its release notes and update the website’s Gemfile using the file linked from that release tag. Pin the same exact theme version in _config.yml so a later rebuild cannot silently pull breaking changes.

See Versions and upgrades for examples and the policy to follow for every future upgrade.

3. Deploy using GitHub Actions

1. Go to Settings > Pages and enable GitHub Actions as a source
2. Go to Environments > github-pages and remove the rule under Deployment branches if you want to deploy other branches than master or main via Workflow Dispatch (manually triggered action)
3. Push a change to master/main branch and the GitHub Actions will be triggered.

Deploy using GitHub Pages (alternative)

This is the quickest way to deploy the elixir-toolkit-theme, but gives less flexibility and does not allow you to make use of the new way of tagging tools. Visit the GitHub documentation to find out more about how to setup GitHub pages.

NOTE: This way of deploying does not support the tool-tag in the text of the Markdown file to tag tools and resources.

4. Checking out your deployment

After waiting a minute or two (deployments can take a while), you can checkout your website. THe deployment is by default served at https://USER.github.io/FORK-NAME/.

5. Making changes

Any change to the master/main branch will automatically trigger the re-deployment of the website, so your changes come live. More information on how you can configure the theme can be found on the other documentation pages:

• Changing the navigation structures
• Configuring the theme
• Applying custom branding
• Markdown cheat sheet

6. Add a LICENSE file to your GitHub repository.

Add a license to your repository using the GitHub instructions.