jekyll-theme-amethyst 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae1f567530a5c557779c453ab8ea18940c3620baa598d0362fe922bd2b6fff2f
+  data.tar.gz: 1c202be8204ee0d9073f337cff0b5145a3ef7019b8b1c59e835e750fe1353c72
+SHA512:
+  metadata.gz: f633624fe399ba7a0258b0109c530d3c45155d2b6c350b3bb655895e36beb07b844275f9b479d3b37794bb98b0ac833120c79be16a9a609f5d5e8605849844f8
+  data.tar.gz: 0102d31b93866380a0018c5529c0c78e018ba10833eb8fa57300fe2463acfc3de746ba4d64894cfe1d4b5bf8e201bab107dbd6e1f677b57f37abb1600df8f26f

data/.github/workflows/doc-search.yaml

@@ -0,0 +1,25 @@
+name: Update search index
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  run:
+    name: Update search index
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        # If your site is in a subdirectory
+        # working-directory: ./
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+
+      - run: bundle exec jekyll algolia
+        # If your site is in a subdirectory
+        # working-directory: ./
+        env:
+          ALGOLIA_API_KEY: "${{ secrets.ALGOLIA_API_KEY }}"

data/.github/workflows/gem.yaml

@@ -0,0 +1,25 @@
+name: Gem
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  gem-push:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Publish Gem package
+      env:
+        GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_PUSH }}"
+      # Inspired by https://github.com/bodyshopbidsdotcom/gh-action-publish-gem-on-tag/blob/1.0.1/entrypoint.sh
+      # Docs: https://guides.rubygems.org/command-reference/#gem-push
+      run: |
+        GIT_VERSION=$(echo "$GITHUB_REF" | cut -d'/' -f 3-)
+        SPEC_VERSION=$(ruby -e 'require "rubygems"; gemspec = Dir.entries(".").find { |file| file =~ /.*\.gemspec/ }; spec = Gem::Specification::load(gemspec); puts spec.version')
+        if [[ "$GIT_VERSION" != "v${SPEC_VERSION}" ]]; then
+          echo "Ignoring, git tag version differs from gem spec version."
+          exit 2;
+        fi
+        gem build *.gemspec
+        gem push *.gem

data/.github/workflows/github-pages.yaml

@@ -0,0 +1,47 @@
+name: GitHub Pages
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-20.04
+    env:
+      DEPLOY_DIR: _site/
+      DEPLOY_BRANCH: gh-pages
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Prepare branch
+        run: |
+          mkdir "${DEPLOY_DIR}"
+          cd "${DEPLOY_DIR}"
+          # Clone and checkout existing branch, or initialise with a new and empty branch
+          git clone --depth 5 --branch "${DEPLOY_BRANCH}" "https://github.com/${GITHUB_REPOSITORY}.git" . || git init -b "${DEPLOY_BRANCH}"
+
+      - uses: ruby/setup-ruby@v1
+        # If your site is in a subdirectory
+        # working-directory: ./
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+
+      - name: Jekyll build
+        # If your site is in a subdirectory
+        # working-directory: ./
+        run: bundle exec jekyll build
+
+      - name: Push to branch
+        # Inspired by https://github.com/helaili/jekyll-action/blob/2.2.0/entrypoint.sh
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+        run: |
+          cd "${DEPLOY_DIR}"
+          touch .nojekyll
+          git config user.name "${GITHUB_ACTOR}" && \
+          git config user.email "${GITHUB_ACTOR}@users.noreply.github.com" && \
+          git add . && \
+          git commit --allow-empty -m "Build commit ${GITHUB_SHA}" && \
+          git push "https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" "HEAD:${DEPLOY_BRANCH}"

data/.github/workflows/spider-check.yaml

@@ -0,0 +1,52 @@
+name: spider-check
+on:
+  # Once a week on Friday at 00:00
+  schedule:
+    - cron: '0 0 * * 5'
+  # Or manually
+  workflow_dispatch:
+  # Or when developing this workflow
+  push:
+    paths:
+      - .github/workflows/spider-check.yaml
+  pull_request:
+    paths:
+      - .github/workflows/spider-check.yaml
+
+jobs:
+  spider-check:
+    env:
+      # Site address to crawl
+      #
+      # If empty, will be derived from a CNAME file or the repo name.
+      #
+      # MY_SITE: https://example.org
+      # MY_SITE: https://example.github.io
+      # MY_SITE: https://example.github.io/my-project/
+      #
+      MY_SITE:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          repository: jquery/hydra-link-checker
+          ref: v1.0.2
+
+      - name: Get site address
+        run: |
+          if [[ "$MY_SITE" == "" ]]; then
+            MY_SITE=$(cat CNAME 2>/dev/null || echo "")
+            if [[ "$MY_SITE" == "" ]]; then
+              REPO_BASENAME=$(echo "$GITHUB_REPOSITORY" | cut -d'/' -f 2)
+              REPO_OWNER=$(echo "$GITHUB_REPOSITORY" | cut -d'/' -f 1)
+              if [[ "$REPO_BASENAME" == "${REPO_OWNER}.github.io" ]]; then
+                MY_SITE="${REPO_OWNER}.github.io"
+              else
+                MY_SITE="${REPO_OWNER}.github.io/${REPO_BASENAME}"
+              fi
+            fi
+            echo "MY_SITE=https://${MY_SITE}" >> $GITHUB_ENV
+          fi
+
+      - name: Run hydra-link-checker
+        run: python3 hydra.py "$MY_SITE"

data/.gitignore

@@ -0,0 +1,4 @@
+/.jekyll-cache/
+/.sass-cache/
+/_site/
+/Gemfile.lock

data/404.md

@@ -0,0 +1,9 @@
+---
+layout: page
+title: Page not found
+permalink: /404.html
+amethyst:
+  hero: false
+---
+
+<p class="lead" markdown="1">It seems we can’t find what you’re looking for.</p>

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+ruby RUBY_VERSION
+
+gemspec
+
+gem "jekyll-algolia", "~> 1.7.0", group: :jekyll_plugins

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+[![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)
+
+# 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
+
+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 <http://localhost:4000/>:
+
+```shell
+bundle exec jekyll serve
+```

data/_config.yml

@@ -0,0 +1,91 @@
+# Configuration for the Amethyst development site
+#
+# DO NOT COPY
+#
+# To create your own site with this theme, use the example branch as
+# your clean and minimal starting point:
+# https://github.com/qunitjs/jekyll-theme-amethyst/tree/example
+#
+# -------
+
+# Site settings
+#
+# Docs: https://jekyllrb.com/docs/configuration/
+title: Amethyst Demo
+description: "An amazing website."
+url: https://qunitjs.github.io
+baseurl: /jekyll-theme-amethyst
+# For pages (not blog posts) this is equivalant to /:title/
+permalink: /:year/:month/:day/:title/
+lang: en
+timezone: UTC
+# Files that will not be converted or published
+exclude:
+  # Exclude internal repo files from site output
+  - docs
+  - lib
+  # Avoid the following on GitHub CI:
+  # > Error: could not read file
+  # > vendor/jekyll/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb:
+  # > Invalid date '<%= Time.now.strftime('%Y-%m-%d %H:%M:%S %z') %>':
+  # > Document does not have a valid date in the YAML front matter.
+  - vendor
+plugins:
+  - jekyll-theme-amethyst
+
+
+# Theme settings
+#
+# Amethyst theme options are documented at:
+# https://github.com/qunitjs/jekyll-theme-amethyst/blob/main/docs/config.md
+#
+theme: jekyll-theme-amethyst
+amethyst:
+  edituri_base: https://github.com/qunitjs/jekyll-theme-amethyst/blob/main/
+  release_base: https://github.com/qunitjs/qunit/releases/tag/
+  github: qunitjs
+  gitter: qunitjs/qunit
+  # https://github.com/qunitjs/jekyll-theme-amethyst/blob/main/docs/getting-started.md#enable-algolia-search
+  algolia:
+    search_only_api_key: f37678e47d7730bbf340e904a81fbbbd
+
+
+# Conversion settings
+#
+highlighter: rouge
+markdown: kramdown
+kramdown:
+  input: GFM
+  toc_levels: "1,2"
+
+
+# Sass settings
+#
+# Docs: https://jekyllrb.com/docs/assets/#sassscss
+sass:
+  style: compressed
+  sourcemap: never
+
+
+# Backend search settings
+#
+# Docs: https://github.com/algolia/jekyll-algolia
+algolia:
+  application_id: 4HMKKPGKKN
+  index_name: amethyst-demo
+  # By default only HTML paragraphs are indexed (and headings, albeit through a different mechanism).
+  # * Include list items (similar to paragraphs).
+  # * Include tables (index per row for better excerpts).
+  # * Include <pre> (typically code examples, omit if it "poisons" results too much).
+  nodes_to_index: "p,li,tr,pre"
+
+
+# Blog archives
+#
+# Docs: https://github.com/jekyll/jekyll-archives/
+jekyll-archives:
+  enabled:
+    - year
+  layout: posts-year
+  permalinks:
+    year: "/:year/"

data/_data/sidebar_api.yml

@@ -0,0 +1,13 @@
+- group: foo
+  expand: true
+
+- group: lorem
+
+- type: list
+  title: Other
+  expand: true
+  list:
+    - url: /api/deprecated/
+      title: Deprecated
+    - url: /api/removed/
+      title: Removed

data/_data/sidebar_blog.yml

@@ -0,0 +1,11 @@
+- type: tags
+  title: Tags
+  expand: true
+
+- type: recent
+  title: Recent posts
+  expand: true
+
+- type: archive
+  title: Archives
+  expand: true

data/_data/sitenav.yml

@@ -0,0 +1,11 @@
+- name: Guides
+  href: /guides/
+  sub:
+    - name: Getting Started
+      href: /intro/
+- name: Documentation
+  href: /api/
+- name: Blog
+  href: /blog/
+- name: About
+  href: /about/

data/_includes/opengraph.html

@@ -0,0 +1,49 @@
+{%- assign feed_page = site.pages | where: 'url', '/feed.xml' | first -%}
+{%- if feed_page -%}
+<link rel="alternate" type="application/rss+xml" href="{{ feed_page.url | relative_url | escape }}" title="{{ site.title | escape }}">
+{% endif -%}
+
+{%- assign page_title = page.title -%}
+{%- if page_title == nil and page.date -%}
+    {%- comment -%}
+    Deal with jekyll-archives refusing to add, or facilitate addition of, a title to archive pages.
+    {%- endcomment -%}
+    {%- if page.type == "year" -%}
+        {%- assign page_title = page.date | date: '%Y' -%}
+    {%- elsif page.type == "month" -%}
+        {%- assign page_title = page.date | date: '%B %Y' -%}
+    {%- endif -%}
+{%- endif -%}
+
+<title>{% if page.url != '/' and page_title %}{{ page_title | escape }} | {% endif %}{{ site.title | escape }}</title>
+
+{%- comment -%}
+    See https://ogp.me/
+{%- endcomment %}
+{% capture opengraph %}
+
+<meta property="og:title" content="{{ page_title | default: site.title | escape }}">
+
+{% if page.excerpt %}
+    {%- assign excerpt = page.excerpt %}
+{% elsif page.layout == "home" %}
+    {% assign excerpt = site.description %}
+{% else %}
+    {% assign excerpt = "" %}
+{% endif %}
+{% if excerpt and excerpt != empty %}
+<meta name="description" content="{{ excerpt | strip_html | truncate: 200 | normalize_whitespace | escape }}">
+<meta property="og:description" content="{{ excerpt | strip_html | truncate: 200 | normalize_whitespace | escape }}">
+{% endif %}
+
+{% if site.amethyst.mastodon %}
+<link rel="me" href="{{ site.amethyst.mastodon | escape }}">
+{% endif %}
+{% if site.amethyst.twitter %}
+<meta name="twitter:creator" content="@{{ site.amethyst.twitter | escape }}">
+<meta name="twitter:site" content="@{{ site.amethyst.twitter | escape }}">
+{% endif %}
+<meta name="twitter:card" content="summary_large_image">
+
+{% endcapture -%}
+{{ opengraph | strip_newlines }}

data/_includes/search-js.html

@@ -0,0 +1,113 @@
+{%- comment -%}
+
+For releases and integrity hashes (SRI), see:
+* https://www.jsdelivr.com/package/npm/algoliasearch
+* https://www.jsdelivr.com/package/npm/autocomplete.js
+
+We use type="module" as a natural way to cut the mustard,
+executing the script only on modern browsers with ES6 support,
+and causing no errors on older browsers.
+
+<https://responsivenews.tumblr.com/post/18948466399/cutting-the-mustard>
+<http://web.archive.org/web/20150305005331/http://responsivenews.co.uk/post/18948466399/cutting-the-mustard>
+
+{%- endcomment -%}
+<script type="module">
+const loadSearch = () => Promise.all([
+    new Promise((resolve) => document.body.append(Object.assign(document.createElement('script'), {
+        crossOrigin: 'anonymous',
+        integrity: 'sha256-YuyfhK9VEyfW6ejFiPbfOX2SELbFrgFU/8tU3MHuh60=',
+        src: 'https://cdn.jsdelivr.net/npm/algoliasearch@4.3.1/dist/algoliasearch-lite.umd.js',
+        onload: resolve
+    }))),
+    new Promise((resolve) => document.body.append(Object.assign(document.createElement('script'), {
+        crossOrigin: 'anonymous',
+        integrity: 'sha256-YVWQosorZnr6fALvOW9VALYuInld27RkSPkElGBdCaU=',
+        src: 'https://cdn.jsdelivr.net/npm/autocomplete.js@0.37.1/dist/autocomplete.min.js',
+        onload: resolve
+    })))
+]);
+const input = document.querySelector('#aa-search-input');
+const form = document.querySelector('#site-search-form');
+let restoreFocus = false;
+async function setupSearch(e) {
+    {% comment -%}
+    // Whether to restore focus after autocomplete.js replaces the input element.
+    // This is before the setup check to account for input before load ends.
+    {%- endcomment -%}
+    restoreFocus = restoreFocus || (e && (e.type === 'click' || e.type === 'focus'));
+    if (setupSearch.setup) return;
+    setupSearch.setup = true;
+    await loadSearch();
+
+    const client = algoliasearch('{{ site.amethyst.algolia.application_id | default: site.algolia.application_id }}', '{{ site.amethyst.algolia.search_only_api_key }}');
+    {% if site.amethyst.algolia.sources -%}
+    const indexSources = {{ site.amethyst.algolia.sources | jsonify }};
+    {%- elsif site.algolia.index_name -%}
+    const indexSources = [{ index: {{ site.algolia.index_name | jsonify }}, base: {{ '' | relative_url | jsonify }} }];
+    {%- else -%}
+    const indexSources = [];
+    {%- endif %}
+    const escapeString = autocomplete.escapeHighlightedString;
+    const autocompleteOptions = {
+        // Debug allows inspecting the suggestions
+        debug: true,
+        // (Re)open suggestions on (re)focus when input is non-empty
+        openOnFocus: true,
+        hint: false,
+        ariaLabel: 'search input',
+        templates: {
+            // https://github.com/algolia/autocomplete.js/issues/248
+            empty(query) {
+                return `No results for "${escapeString(query.query)}".`;
+            }
+            {%- if site.amethyst.algolia.branding != "none" %},
+            footer: '<div class="aa-footer">Search by <a class="aa-logo" href="https://algolia.com" target="_blank">Algolia</a></div>'{% endif %}
+        }
+    };
+    function formatURL(suggestion) {
+        return (suggestion.anchor && !suggestion.url.includes('#')) ? suggestion.url + '#' + suggestion.anchor : suggestion.url;
+    }
+    function newHitsSource(index, params) {
+        return function(query, cb) {
+            index.search(query, params).then(
+                res => { cb(res.hits, res); },
+                err => { cb([]); console.error(err); }
+            );
+        };
+    }
+    const autocompleteSources = indexSources.map(source => ({
+        source: newHitsSource(client.initIndex(source.index), { hitsPerPage: 5 }),
+        displayKey: '',
+        templates: {
+            suggestion(suggestion) {
+                const title = [ suggestion.title ].concat(suggestion.headings || []).join(' › ');
+                const content = suggestion._highlightResult.content && suggestion._highlightResult.content.value || '';
+                suggestion._href = (source.base || '') + formatURL(suggestion);
+                return `<a href="${suggestion._href}" tabindex="-1">
+                    <p class="aa-suggestion_title">${title}</p>
+                    <p class="aa-suggestion_content">${content}</p>
+                </a>`;
+            }
+        }
+    }));
+    const $input = autocomplete('#aa-search-input', autocompleteOptions, autocompleteSources)
+        .on('autocomplete:selected', (e, suggestion) => location.href = suggestion._href || suggestion.url);
+
+    if (restoreFocus) $input.focus();
+
+    // Disable fallback form
+    form.addEventListener('submit', (e) => {
+        e.preventDefault();
+    });
+}
+document.addEventListener('keydown', (e) => {
+    if (e.key === '/' && !(document.activeElement && /^(INPUT|TEXTAREA)$/.test(document.activeElement.tagName))) {
+        input.focus();
+        e.preventDefault();
+    }
+});
+input.addEventListener('focus', setupSearch, { once: true });
+form.addEventListener('click', setupSearch, { once: true });
+form.classList.add('site-search--bound');
+</script>