Skip to content

Latest commit

 

History

History
200 lines (140 loc) · 8.72 KB

README.md

File metadata and controls

200 lines (140 loc) · 8.72 KB
Raw
permalink
/

Gem Version Jekyll site CI DOI

ELIXIR Toolkit Theme

The ELIXIR toolkit theme is a Jekyll theme designed to support easy deployment of documentation websites but also more complex ones that require a central tool table and linking towards ELIXIR resources.

Its key features:

  • Easy deployment using GitHub Pages or GitHub Actions
  • Advanced content search
  • Create your own look with the many theme variables and support for custom classes
  • Support for a central tools table
  • Integrated attribution for contributors, editors and affiliations
  • Page tagging and listing of those tagged pages
  • Linking to ELIXIR resources including Bio.tools, FAIRsharing, FAIR Cookbook, RDMkit, TeSS and DSW
  • Easy side navigation, top navigation and footer management
  • Mobile friendly
  • Create website sections with each section having its own sidebar
  • Out of the box search engine optimizations including schema.org attributes and many other metadata attributes
  • Web analytics through Matomo, Google Analytics or Plausible

Enabling the theme on your Jekyll project

The quickest way to use the elixir-toolkit-theme is setting it as a remote theme in your config.yml file:

remote_theme: ELIXIR-Belgium/elixir-toolkit-theme

You can lock it onto a specific version using:

remote_theme: ELIXIR-Belgium/[email protected]

Using Ruby Gems (alternative)

Alternatively you can use the Ruby Gem of the theme (needed when using GitLab) by adding this line to your Jekyll site's Gemfile:

gem "elixir-toolkit-theme"

You can lock it onto a specific version like this:

gem "elixir-toolkit-theme", "~> 3.2.0"

And add this line to your Jekyll site's _config.yml:

theme: elixir-toolkit-theme

Deployment

Via GitHub Actions

  1. Make sure you have a GitHub workflow file setup similar to the one in this repo at .github/workflows/jekyll.yml.
  2. Go to Settings > Actions and enable Allow all actions and reusable workflows
  3. Got to the Actions tab of the repository and trust the workflows to run.
  4. Go to Settings > Pages and enable GitHub Actions as a source
  5. 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)
  6. Trigger the workflow by pushing a change to main or manually trigger the actions within the Actions tab of the repository.

Via GitHub Pages

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.

Via GitLab Pages

Add an extra .gitlab-ci.yml file in the root of the repo with:

image: ruby:2.7

variables:
  JEKYLL_ENV: production

before_script:
  - bundle install

pages:
  stage: deploy
  script:
  - bundle exec jekyll build -d public
  artifacts:
    paths:
    - public
  only:
  - master

Locally using Jekyll

  1. If not already present on your machine, install ruby.

  2. Install Jekyll

    If you have never installed or run a Jekyll site locally on your computer, follow these instructions to install Jekyll: https://jekyllrb.com/docs/installation/

    gem install jekyll

  3. Install dependencies

    bundle install

  4. Deploy website locally in development mode:

    bundle exec jekyll serve

    If you want to deploy the website locally in production mode, do:

    JEKYLL_ENV=production PAGES_REPO_NWO='USER_OR_ORGANISATION/REPO_NAME' bundle exec jekyll serve --baseurl ""

  5. To preview your site, in your web browser, navigate to http://localhost:4000.

Additional information can be found at the following link: https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll

Locally using Docker

If not already installed on your machine, install Docker. From the root of the elixir-toolkit-theme directory, run:

docker run -it --rm -p [::1]:4000:4000 -v $PWD:/srv/jekyll jekyll/jekyll:latest /bin/bash -c "chmod a+w /srv/jekyll/Gemfile.lock && chmod 777 /srv/jekyll && bundle install && bundle exec jekyll serve --host 0.0.0.0"

This will start the docker container and serve the website locally. Make sure the .\_site is not yet created to avoid permission errors.

This theme is known to be used in

Dependencies

This theme would not be possible without following open source projects:

  • Bootstrap5 - As main CSS framework
  • DataTables - To generate tables that are sortable, searchable and contain pagination
  • AnchorJS - Adds deep anchor links to the headings
  • lunr.js - Main tool behind the search bar enabling content search
  • jQuery - A fast, small, and feature-rich JavaScript library for easy scripting
  • jekyll-table-of-contents - Lightweight JS script to render the table of contents
  • jQuery Navgoco Menus - Multi-level slide navigation with accordion effect
  • Font-Awesome - The famous icon library
  • flag-icons - A curated collection of all country flags in SVG + css integration
  • clipboard.js - Modern copy to clipboard. No Flash. Just 3kb gzipped clipboard.

Attribution

If you like our work, you can add following badge to the readme of your project:

[![theme badge](https://img.shields.io/badge/ELIXIR%20toolkit%20theme-jekyll-blue?color=0d6efd)](https://github.com/ELIXIR-Belgium/elixir-toolkit-theme)

theme badge

License

The theme is available as open source under the terms of the MIT License.