elixir-belgium/elixir-toolkit-theme-example

Example the of ELIXIR toolkit theme as a remote Jjekyll theme

ELIXIR Toolkit Theme example

This repository serves as an example on how to deploy the ELIXIR Toolkit Theme.

Why this separate repo

This repo should demonstrate how easy it is to setup the theme, but more importantly, to show how small the amount is you need. This is really the fresh, bare bone start you want when using the theme from scratch. 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.

Get started

1. Fork this repository

Click on the Fork button in the top right of GitHub to fork this repository.

2. 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.

3. 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/.

4. 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 using these links:

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

And many more documentation pages can be found on the original ELIXIR Toolkit Theme website.

5. Add a LICENSE file to your GitHub repository.

Add a license to your repository using the GitHub instructions.