README.md

Amethyst theme

This repository houses the Amethyst theme for Jekyll.

Getting started

To create a new site, use the Getting started guide, or browse the minimal example in the example branch.

Credits

The theme was designed by Trent Willis in 2018 for the qunitjs.com website (qunitjs/qunitjs.com#151).

Thanks to Leo Balter for initiating the use of Markdown-based static sites for QUnit in 2015 (qunitjs/api.qunitjs.com#150).

Contributing

Local development

Requirements:

• Ruby (tested with Ruby 2.7+)
• Bundler (if missing, install with gem install bundler)

To install or update Jekyll and plugins:

bundle update

To generate the site and serve it locally at http://localhost:4000/:

bundle exec jekyll serve

Releasing

• Edit amethyst.gemspec and set the next release number.
• Stage and commit the changes:

  git add -p
  git commit
    # Tag v0.0.0
  git push
  

• Create a signed semver tag, and push it:

  git tag -s v0.0.0
  # Tag v0.0.0
  git push --tags
  

• CI will create and publish a new package to https://rubygems.org/gems/jekyll-theme-amethyst.