Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/qunitjs/jekyll-theme-amethyst

jekyll

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/qunitjs/jekyll-theme-amethyst
Owner: qunitjs
License: mit
Created: 2020-07-26T20:12:58.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-04-01T04:40:37.000Z (9 months ago)
Last Synced: 2024-05-02T14:24:14.741Z (8 months ago)
Topics: jekyll
Language: HTML
Homepage: https://qunitjs.github.io/jekyll-theme-amethyst/
Size: 538 KB
Stars: 5
Watchers: 7
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        [![Build Status: spider-check](https://github.com/qunitjs/jekyll-theme-amethyst/actions/workflows/spider-check.yaml/badge.svg)](https://github.com/qunitjs/jekyll-theme-amethyst/actions/workflows/spider-check.yaml)

[![rubygems.org: jekyll-theme-amethyst](https://badge.fury.io/rb/jekyll-theme-amethyst.svg)](https://rubygems.org/gems/jekyll-theme-amethyst)

# Amethyst theme

This repository houses the Amethyst theme for Jekyll.

## Getting started

To create a new site, use the **[Getting started](docs/getting-started.md)** guide,

or browse the minimal example in the [example](https://github.com/qunitjs/jekyll-theme-amethyst/tree/example) branch.

## Credits

The theme was designed by [Trent Willis](https://github.com/trentmwillis/) in 2018 for the [qunitjs.com](https://qunitjs.com/) website ([qunitjs/qunitjs.com#151](https://github.com/qunitjs/qunitjs.com/issues/151#issuecomment-655154878)).

Thanks to [Leo Balter](https://github.com/leobalter) for initiating the use of Markdown-based static sites for QUnit in 2015 ([qunitjs/api.qunitjs.com#150](https://github.com/qunitjs/api.qunitjs.com/pull/150)).

## Contributing

### Local development

Requirements:

* [Ruby](https://www.ruby-lang.org/) (tested with Ruby 2.7+)

* [Bundler](https://bundler.io/) (if missing, install with `gem install bundler`)

To install or update Jekyll and plugins:

```shell

bundle update

```

To generate the site and serve it locally at :

```shell

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 .