diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index b7ca95b..0000000 --- a/.gitattributes +++ /dev/null @@ -1,5 +0,0 @@ -# Auto detect text files and perform LF normalization -* text=auto - -# JS files must always use LF for tools to work -*.js eol=lf diff --git a/.gitignore b/.gitignore index 300bee5..09ae38d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ /.sass-cache/ /_site/ +/Gemfile.lock diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index db6c004..0000000 --- a/.travis.yml +++ /dev/null @@ -1,9 +0,0 @@ -language: ruby -cache: bundler -script: - - bundle exec jekyll algolia -branches: - only: - - master -rvm: - - 2.7 diff --git a/CNAME b/CNAME deleted file mode 100644 index 5109973..0000000 --- a/CNAME +++ /dev/null @@ -1 +0,0 @@ -qunitjs.com diff --git a/Gemfile b/Gemfile index 5258a24..ceacd53 100644 --- a/Gemfile +++ b/Gemfile @@ -2,4 +2,3 @@ source "https://rubygems.org" ruby RUBY_VERSION gem 'github-pages', group: :jekyll_plugins -gem 'jekyll-algolia', group: :jekyll_plugins diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index 229b556..0000000 --- a/Gemfile.lock +++ /dev/null @@ -1,272 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - activesupport (6.0.3.2) - concurrent-ruby (~> 1.0, >= 1.0.2) - i18n (>= 0.7, < 2) - minitest (~> 5.1) - tzinfo (~> 1.1) - zeitwerk (~> 2.2, >= 2.2.2) - addressable (2.7.0) - public_suffix (>= 2.0.2, < 5.0) - algolia_html_extractor (2.6.2) - json (~> 2.0) - nokogiri (~> 1.10.4) - algoliasearch (1.27.3) - httpclient (~> 2.8, >= 2.8.3) - json (>= 1.5.1) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.11.1) - colorator (1.1.0) - commonmarker (0.17.13) - ruby-enum (~> 0.5) - concurrent-ruby (1.1.6) - dnsruby (1.61.3) - addressable (~> 2.5) - em-websocket (0.5.1) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0.6.0) - ethon (0.12.0) - ffi (>= 1.3.0) - eventmachine (1.2.7) - execjs (2.7.0) - faraday (1.0.1) - multipart-post (>= 1.2, < 3) - ffi (1.13.1) - filesize (0.2.0) - forwardable-extended (2.6.0) - gemoji (3.0.1) - github-pages (206) - github-pages-health-check (= 1.16.1) - jekyll (= 3.8.7) - jekyll-avatar (= 0.7.0) - jekyll-coffeescript (= 1.1.1) - jekyll-commonmark-ghpages (= 0.1.6) - jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.13.0) - jekyll-gist (= 1.5.0) - jekyll-github-metadata (= 2.13.0) - jekyll-mentions (= 1.5.1) - jekyll-optional-front-matter (= 0.3.2) - jekyll-paginate (= 1.1.0) - jekyll-readme-index (= 0.3.0) - jekyll-redirect-from (= 0.15.0) - jekyll-relative-links (= 0.6.1) - jekyll-remote-theme (= 0.4.1) - jekyll-sass-converter (= 1.5.2) - jekyll-seo-tag (= 2.6.1) - jekyll-sitemap (= 1.4.0) - jekyll-swiss (= 1.0.0) - jekyll-theme-architect (= 0.1.1) - jekyll-theme-cayman (= 0.1.1) - jekyll-theme-dinky (= 0.1.1) - jekyll-theme-hacker (= 0.1.1) - jekyll-theme-leap-day (= 0.1.1) - jekyll-theme-merlot (= 0.1.1) - jekyll-theme-midnight (= 0.1.1) - jekyll-theme-minimal (= 0.1.1) - jekyll-theme-modernist (= 0.1.1) - jekyll-theme-primer (= 0.5.4) - jekyll-theme-slate (= 0.1.1) - jekyll-theme-tactile (= 0.1.1) - jekyll-theme-time-machine (= 0.1.1) - jekyll-titles-from-headings (= 0.5.3) - jemoji (= 0.11.1) - kramdown (= 1.17.0) - liquid (= 4.0.3) - mercenary (~> 0.3) - minima (= 2.5.1) - nokogiri (>= 1.10.4, < 2.0) - rouge (= 3.19.0) - terminal-table (~> 1.4) - github-pages-health-check (1.16.1) - addressable (~> 2.3) - dnsruby (~> 1.60) - octokit (~> 4.0) - public_suffix (~> 3.0) - typhoeus (~> 1.3) - html-pipeline (2.13.0) - activesupport (>= 2) - nokogiri (>= 1.4) - http_parser.rb (0.6.0) - httpclient (2.8.3) - i18n (0.9.5) - concurrent-ruby (~> 1.0) - jekyll (3.8.7) - addressable (~> 2.4) - colorator (~> 1.0) - em-websocket (~> 0.5) - i18n (~> 0.7) - jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 2.0) - kramdown (~> 1.14) - liquid (~> 4.0) - mercenary (~> 0.3.3) - pathutil (~> 0.9) - rouge (>= 1.7, < 4) - safe_yaml (~> 1.0) - jekyll-algolia (1.6.0) - algolia_html_extractor (~> 2.6) - algoliasearch (~> 1.26) - filesize (~> 0.1) - jekyll (>= 3.6, < 5.0) - json (~> 2.0) - nokogiri (~> 1.6) - progressbar (~> 1.9) - verbal_expressions (~> 0.1.5) - jekyll-avatar (0.7.0) - jekyll (>= 3.0, < 5.0) - jekyll-coffeescript (1.1.1) - coffee-script (~> 2.2) - coffee-script-source (~> 1.11.1) - jekyll-commonmark (1.3.1) - commonmarker (~> 0.14) - jekyll (>= 3.7, < 5.0) - jekyll-commonmark-ghpages (0.1.6) - commonmarker (~> 0.17.6) - jekyll-commonmark (~> 1.2) - rouge (>= 2.0, < 4.0) - jekyll-default-layout (0.1.4) - jekyll (~> 3.0) - jekyll-feed (0.13.0) - jekyll (>= 3.7, < 5.0) - jekyll-gist (1.5.0) - octokit (~> 4.2) - jekyll-github-metadata (2.13.0) - jekyll (>= 3.4, < 5.0) - octokit (~> 4.0, != 4.4.0) - jekyll-mentions (1.5.1) - html-pipeline (~> 2.3) - jekyll (>= 3.7, < 5.0) - jekyll-optional-front-matter (0.3.2) - jekyll (>= 3.0, < 5.0) - jekyll-paginate (1.1.0) - jekyll-readme-index (0.3.0) - jekyll (>= 3.0, < 5.0) - jekyll-redirect-from (0.15.0) - jekyll (>= 3.3, < 5.0) - jekyll-relative-links (0.6.1) - jekyll (>= 3.3, < 5.0) - jekyll-remote-theme (0.4.1) - addressable (~> 2.0) - jekyll (>= 3.5, < 5.0) - rubyzip (>= 1.3.0) - jekyll-sass-converter (1.5.2) - sass (~> 3.4) - jekyll-seo-tag (2.6.1) - jekyll (>= 3.3, < 5.0) - jekyll-sitemap (1.4.0) - jekyll (>= 3.7, < 5.0) - jekyll-swiss (1.0.0) - jekyll-theme-architect (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.5.4) - jekyll (> 3.5, < 5.0) - jekyll-github-metadata (~> 2.9) - jekyll-seo-tag (~> 2.0) - jekyll-theme-slate (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.5.3) - jekyll (>= 3.3, < 5.0) - jekyll-watch (2.2.1) - listen (~> 3.0) - jemoji (0.11.1) - gemoji (~> 3.0) - html-pipeline (~> 2.2) - jekyll (>= 3.0, < 5.0) - json (2.3.1) - kramdown (1.17.0) - liquid (4.0.3) - listen (3.2.1) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.3.6) - mini_portile2 (2.4.0) - minima (2.5.1) - jekyll (>= 3.5, < 5.0) - jekyll-feed (~> 0.9) - jekyll-seo-tag (~> 2.1) - minitest (5.14.1) - multipart-post (2.1.1) - nokogiri (1.10.9) - mini_portile2 (~> 2.4.0) - octokit (4.18.0) - faraday (>= 0.9) - sawyer (~> 0.8.0, >= 0.5.3) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - progressbar (1.10.1) - public_suffix (3.1.1) - rb-fsevent (0.10.4) - rb-inotify (0.10.1) - ffi (~> 1.0) - rouge (3.19.0) - ruby-enum (0.8.0) - i18n - rubyzip (2.3.0) - safe_yaml (1.0.5) - sass (3.7.4) - sass-listen (~> 4.0.0) - sass-listen (4.0.0) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - sawyer (0.8.2) - addressable (>= 2.3.5) - faraday (> 0.8, < 2.0) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) - thread_safe (0.3.6) - typhoeus (1.4.0) - ethon (>= 0.9.0) - tzinfo (1.2.7) - thread_safe (~> 0.1) - unicode-display_width (1.7.0) - verbal_expressions (0.1.5) - zeitwerk (2.3.1) - -PLATFORMS - ruby - -DEPENDENCIES - github-pages - jekyll-algolia - -RUBY VERSION - ruby 2.7.1p83 - -BUNDLED WITH - 2.1.4 diff --git a/LICENSE.txt b/LICENSE.txt index f642c3f..4607b42 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,4 +1,5 @@ -Copyright OpenJS Foundation and other contributors, https://openjsf.org/ +Copyright (c) 2020 Timo Tijhof +Copyright (c) 2018 Trent Willis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/README.md b/README.md index fd29fc2..759eef6 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,4 @@ -# qunitjs.com +# Amethyst theme -This repository houses the content and code for the [qunitjs.com](https://qunitjs.com/) website. - -## Development - -Requirements: - -* [Ruby](https://www.ruby-lang.org/) (tested with Ruby 2.6+) -* [Bundler](https://bundler.io/) (if missing, install with `gem install bundler`) - -To install Jekyll and plugins the first time: - -```shell -bundle install -``` - -To update Jekyll and any plugins (e.g. after changes to `Gemfile`): - -```shell -bundle update -``` - -To regenerate the site and serve locally at : - -```shell -bundle exec jekyll serve -``` +This repository houses the Amethyst theme for Jekyll. +Originally designed by [Trent Willis](https://github.com/trentmwillis/) in 2018 for the [qunitjs.com](https://qunitjs.com/) website. diff --git a/_config.yml b/_config.yml index d4e2689..e2fb213 100644 --- a/_config.yml +++ b/_config.yml @@ -1,45 +1,53 @@ -# Welcome to Jekyll! +# Site settings # -# This config file is meant for settings that affect your whole site. -# These values are expected to rarely change. If you are editing this file -# very often, consider using Jekyll's data files feature. -# -# For technical reasons, this file is *NOT* reloaded automatically when you use -# 'bundle exec jekyll serve'. If you change this file, please restart the server process. - -## Site settings -## https://jekyllrb.com/docs/configuration/ - -title: QUnit -description: "The powerful, easy-to-use JavaScript testing framework." -# the base hostname and protocol for your site -url: "https://qunitjs.com" -# the subpath of your site, e.g. /blog +# https://jekyllrb.com/docs/configuration/ +title: Site Title +description: "An amazing website." +# The canonical hostname for your site +url: +# The subpath of the canonical address (leave as "" if not in a subdirectory) baseurl: "" - -plugins: - # https://help.github.com/articles/redirects-on-github-pages/ - - jekyll-redirect-from - -# Theme -# We have a custom theme so the Jekyll is ignored. -# But, the default theme setting for github-pages is 'primer', -# which Jekyll would still try to compile. This is a problem because -# since at least 2015, the combination of Jekyll/Sass/Primer is -# broken and simply doesn't compile out of-the-box. -# +# This a custom theme so the native Jekyll theme system is ignored. +# But, we use github-pages which has a default theme of 'primer'. +# This is a problem because, even if we ignore its output file, +# the combination of Jekyll/Sass/Primer has compile errors: # - https://github.com/jekyll/jekyll/issues/7426 # - https://github.com/jekyll/jekyll/issues/4268 # - https://github.com/sindresorhus/gulp-ruby-sass/issues/232 -# - etc. +# Workaround by disabling this. – https://github.com/github/pages-gem/issues/613 +theme: null + +# Theme settings # -# Workaround by using the 'minima' for this no-op setting, -# which does compile an (unused) file without issue. -theme: minima +# https://github.com/qunitjs/jekyll-theme-amethyst amethyst: - twitter: qunitjs - github: qunitjs - gitter: qunitjs/qunit + header_logo: + src: + width: + height: + # Twitter.com username (without "@") + twitter: + # GitHub.com organisation or username + github: + # Gitter.im room (e.g. "qunitjs/qunit") + gitter: + # Frontend search powered by Algolia + algolia: + search_only_api_key: + # Default: `algolia.application_id`. + application_id: + # Which indexes to use as autocomplete source + # For example, to support multiple sources: + # + # ``` + # sources: + # - index: qunitjs-api + # base: https://api.qunitjs.com + # - index: qunitjs + # ``` + # + # Default: Single source based on`algolia.index_name`. + sources: # Conversion highlighter: rouge @@ -48,27 +56,19 @@ kramdown: input: GFM toc_levels: "1,2" -# Search +# Backend search index +# +# This applies to the 'jekyll algolia' command. +# Requires the ALGOLIA_API_KEY secret environment variable. +# For an example, see . +# +# See . algolia: - application_id: HOJ487LP0L - # Which index the Travis job will create/update - # with the content of the current Jekyll site. - # The auth key for this is injected as secure env variable. - index_name: qunitjs + application_id: + # Which index to submit content to + index_name: + # Which markdown pages to ignore files_to_exclude: - # Index destination instead of intermediary - - guides.md - # Auth key for client-side search queries. - search_only_api_key: aed00982db05bd21dd05310be057bda8 - -# Input files -exclude: - - Gemfile - - Gemfile.lock - - README.md - - CONTRIBUTING.md - - CNAME - - vendor # Output -permalink: title/ +permalink: :title/ diff --git a/_data/plugins.json b/_data/plugins.json deleted file mode 100644 index fe16dcf..0000000 --- a/_data/plugins.json +++ /dev/null @@ -1,19 +0,0 @@ -[{"name":"qunit-reporter-junit","description":"Produce JUnit-style XML test reports with QUnit.","maintainers":[{"username":"jamesmgreene","email":"james.m.greene@gmail.com"}],"keywords":["qunit","qunit-plugin","qunit-reporter","junit","xunit","ci","jenkins"],"version":"1.1.1","date":"2016-10-16T01:23:43.596Z"} -,{"name":"qunit-assert-html","description":"QUnit HTML assertion addon","maintainers":[{"username":"jamesmgreene","email":"james.m.greene@gmail.com"}],"keywords":["qunit-plugin","qunit-assert","qunit","assert","HTML","assertHTMLEquals","DOM"],"version":"1.1.0","date":"2016-10-03T02:49:50.045Z"} -,{"name":"qunit-composite","description":"Run multiple QUnit test suite pages.","maintainers":[{"username":"jamesmgreene","email":"james.m.greene@gmail.com"}],"keywords":["qunit","qunit-plugin","composite","multiple","suites","pages"],"version":"2.0.0","date":"2016-10-02T01:26:01.185Z"} -,{"name":"qunit-assert-step","description":"A QUnit plugin for asserting the proper sequence in which the code should execute.","maintainers":[{"username":"jamesmgreene","email":"james.m.greene@gmail.com"}],"keywords":["qunit-plugin","qunit-assert","qunit","assert","order","step"],"version":"1.1.1","date":"2016-10-03T03:46:41.981Z"} -,{"name":"qunit-assert-close","description":"A QUnit plugin for asserting that a number is approximately equal (or not) to an expected number, within a given tolerance.","maintainers":[{"username":"jamesmgreene","email":"james.m.greene@gmail.com"}],"keywords":["qunit-plugin","qunit-assert","qunit","assert","close","close-enough","roughlyEquals","closeTo","approximate"],"version":"2.1.2","date":"2016-10-02T02:25:51.041Z"} -,{"name":"qunit-theme-ninja","description":"A QUnit theme for ninjas.","maintainers":[{"username":"krinkle","email":"krinklemail@gmail.com"}],"keywords":["qunit","qunit-plugin","qunit-theme"],"version":"1.1.0","date":"2014-04-23T16:35:36.572Z"} -,{"name":"qunit-assert-canvas","description":"A QUnit plugin for asserting individual pixel values within a Canvas element.","maintainers":[{"username":"jamesmgreene","email":"james.m.greene@gmail.com"}],"keywords":["qunit-plugin","qunit-assert","qunit","assert","canvas","drawImage","image","draw","render"],"version":"1.1.0","date":"2016-10-02T02:25:02.752Z"} -,{"name":"qunit-assert-classes","description":"A set of assertions for checking thats an element has ( or does not have ) any number of classes. The check is order independent and gives a diff of the expected classes.","maintainers":[{"username":"arschmitz","email":"arschmitz@gmail.com"}],"keywords":["qunit-plugin","qunit-assert","qunit","assert","classes"],"version":"1.0.2","date":"2015-04-29T19:09:20.175Z"} -,{"name":"qunit-pending","description":"A QUnit plugin to add the \"pending\" test syntax to QUnit, a la Mocha.","maintainers":[{"username":"jamesmgreene","email":"james.m.greene@gmail.com"}],"keywords":["qunit-plugin","qunit-test","qunit","test","unit test","pending","skip","skipped","not implemented yet","stub","future"],"version":"1.0.0","date":"2016-10-02T01:55:55.632Z"} -,{"name":"qunit-reporter-lcov","description":"Produce lcov test reports with QUnit","maintainers":[{"username":"piranna","email":"piranna@gmail.com"}],"keywords":["qunit","qunit-plugin","qunit-reporter","lcov"],"version":"1.0.2","date":"2015-03-15T20:31:35.403Z"} -,{"name":"qunit-assert-compare","description":"A QUnit plugin for asserting numerical comparisons like greater than, less than, etc.","maintainers":[{"username":"jamesmgreene","email":"james.m.greene@gmail.com"}],"keywords":["qunit-plugin","qunit-assert","assert","qunit","less","lesser","lessThan","less than","lesserThan","lesser than","greater","greaterThan","greater than","lessThanOrEqual","less than or equal","lesserThanOrEqual","lesser than or equal","greaterThanOrEqual","greater than or equal","equal","notEqual","not equal","compare","comparison","numerical comparison","lt","lte","gt","gte","eq","neq"],"version":"1.1.0","date":"2016-10-02T03:13:17.701Z"} -,{"name":"qunit-theme-gabe","description":"A QUnit theme by Gabe Hendry.","maintainers":[{"username":"krinkle","email":"krinklemail@gmail.com"}],"keywords":["qunit","qunit-plugin","qunit-theme"],"version":"1.0.1","date":"2013-05-06T23:33:24.707Z"} -,{"name":"qunit-theme-nv","description":"A QUnit theme.","maintainers":[{"username":"krinkle","email":"krinklemail@gmail.com"}],"keywords":["qunit","qunit-plugin","qunit-theme"],"version":"1.0.1","date":"2013-05-07T00:46:25.641Z"} -,{"name":"qunit-dark","description":"A kind of dark theme for qunit","maintainers":[{"username":"royriojas","email":"royriojas@gmail.com"}],"keywords":["qunit","qunit-plugin","qunit-theme","qunit theme dark"],"version":"0.1.5","date":"2014-03-20T17:47:37.864Z"} -,{"name":"qunit-assert-nodes","description":"A QUnit plugin providing a convenient API for batch acceptance assertions","maintainers":[{"username":"dsheiko","email":"web.sbelarus@gmail.com"}],"keywords":["jquery","qunit-plugin","qunit-assert","qunit","assert","order"],"version":"0.0.3","date":"2013-06-25T07:56:50.394Z"} -,{"name":"qunit-special-blend","description":"A QUnit plugin/hack/wrapper which allows the user to designiate single tests or modules to run.","maintainers":[{"username":"jarrodctaylor","email":"jarrod.c.taylor@gmail.com"}],"keywords":["qunit-plugin","qunit","unit testing","test case"],"version":"1.1.1","date":"2014-11-23T01:26:37.775Z"} -,{"name":"karma-qunit-special-blend","description":"A QUnit plugin/hack/wrapper which allows the user to designiate single tests or modules to run.","maintainers":[{"username":"jarrodctaylor","email":"jarrod.c.taylor@gmail.com"}],"keywords":["karma-plugin","qunit-plugin","qunit","unit testing","test case"],"version":"1.1.1","date":"2014-11-23T01:14:02.286Z"} -,{"name":"qunit-theme-burce","description":"A QUnit theme by Bryce Dorn.","maintainers":[{"username":"brycedorn","email":"brycedorn@gmail.com"}],"keywords":["qunit","burce","qunit-plugin","qunit-theme"],"version":"1.0.0","date":"2014-06-09T22:03:07.465Z"} -] diff --git a/_data/sitenav.yml b/_data/sitenav.yml index aba35f8..a983925 100644 --- a/_data/sitenav.yml +++ b/_data/sitenav.yml @@ -3,10 +3,6 @@ sub: - name: Getting Started href: /intro/ - - name: Plugins - href: /plugins/ - - name: 2.x Upgrade Guide - href: /upgrade-guide-2.x/ - name: Documentation href: https://api.qunitjs.com - name: About diff --git a/_includes/search.html b/_includes/search.html index d0d4bb8..e7df0e9 100644 --- a/_includes/search.html +++ b/_includes/search.html @@ -15,9 +15,14 @@ - + {%- endif %}