jekyll-theme-amethyst 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d478567d792fb9752288273d79106286df6ef6ef3031d87fdcf16d63020c0d7d
-  data.tar.gz: 938cf6b1fe0b22eecb926cc6dc4315e27949e644c3682df2312fc3e90749f409
+  metadata.gz: 9eb8365c83817b28e320f98115fd844f545cb6ffea498929bf019491a0a348f1
+  data.tar.gz: 68aa630aa212dcde459e337439147af95841d37afcf255d05a7a276de628c598
 SHA512:
-  metadata.gz: 581e0dd5940ff83d59bddaa0ffa0ccd2e03de9c3359cf2e2b89a101d50d54e2d1613ec3af8ae197588a8e77c30812066c5e1fc1c0bb15537914ba0f1533e6ab1
-  data.tar.gz: 404fe3d0b4e3abe29168e9a8e644d6e5f482e821c4b05eec34d30e3c976bacbb73f78ed1b0d2e639f8a05438ab9d234ee7dedc63de19e7c21fa26b00392581df
+  metadata.gz: 4a1046d94dc73a148f6a1f577a3b779721a0516558fedcf2ba05c0ea2d69c4a4e0b463d0408877dea7c9a36b107f85b7af7ba9a47698a5f0c22e95b4b0ff39f9
+  data.tar.gz: 8658b2601fe8ddaf4bfc3c4fcd87f7154ed095306a51ef445c7ff8c05b4852a0c930c0dc193b1db1844dcf80b47a787381a1922be93e0c55793842b0fee05765

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

@@ -22,11 +22,11 @@ jobs:
           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
+          # If your site is in a subdirectory
+          # working-directory: ./
 
       - name: Jekyll build
         # If your site is in a subdirectory

data/.github/workflows/typesense.yaml

@@ -0,0 +1,29 @@
+name: typesense
+on:
+  # Once a week on Wednesday at 11:45 UTC <https://crontab.guru/>
+  schedule:
+    - cron: '45 11 * * 3'
+  # Or after a deployment
+  push:
+    branches:
+      - main
+      - typesense
+  # Or manually
+  workflow_dispatch:
+jobs:
+  typesense:
+    name: Update Typesense
+    if: ${{ github.repository_owner == 'qunitjs' }} # skip on forks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Docsearch Scraper
+        shell: bash
+        run: |
+          docker run \
+            -e TYPESENSE_API_KEY=${{ secrets.TYPESENSE_ADMIN_KEY }} \
+            -e TYPESENSE_HOST="${{ secrets.TYPESENSE_HOST }}" \
+            -e TYPESENSE_PORT="443" \
+            -e TYPESENSE_PROTOCOL="https" \
+            -e CONFIG="$(cat docsearch.config.json | jq -r tostring)" \
+            typesense/docsearch-scraper:0.6.0.rc2

data/Gemfile

@@ -2,5 +2,3 @@ source "https://rubygems.org"
 ruby RUBY_VERSION
 
 gemspec
-
-gem "jekyll-algolia", "~> 1.7.0", group: :jekyll_plugins

data/README.md

@@ -1,4 +1,5 @@
 [![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
 
@@ -17,6 +18,8 @@ Thanks to [Leo Balter](https://github.com/leobalter) for initiating the use of M
 
 ## Contributing
 
+### Local development
+
 Requirements:
 
 * [Ruby](https://www.ruby-lang.org/) (tested with Ruby 2.7+)
@@ -33,3 +36,21 @@ To generate the site and serve it locally at <http://localhost:4000/>:
 ```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 <https://rubygems.org/gems/jekyll-theme-amethyst>.

data/_config.yml

@@ -45,9 +45,11 @@ amethyst:
   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
+  # https://github.com/qunitjs/jekyll-theme-amethyst/blob/main/docs/getting-started.md#enable-typesense
+  typesense:
+    origin: https://typesense.jquery.com
+    collection: amethyst_demo
+    search_only_api_key: Zh8mMgohXECel9wjPwqT7lekLSG3OCgz
 
 
 # Conversion settings
@@ -67,19 +69,6 @@ sass:
   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/

data/_data/sidebar_api.yml

@@ -4,10 +4,14 @@
 
 - group: lorem
 
-- type: link
-  url: /api/deprecated/
+- group: deprecated
+  expand: false
   title: Deprecated
 
-- type: link
-  url: /api/removed/
+- group: removed
+  expand: false
   title: Removed
+
+- type: link
+  url: /api/foo/quux/
+  title: Quux

data/_includes/opengraph.html

@@ -45,5 +45,11 @@
 {% endif %}
 <meta name="twitter:card" content="summary_large_image">
 
+
+{% if layout.amethyst.pagetype == "navigation" %}
+<meta name="robots" content="{{ layout.amethyst.robots | default: 'noindex,follow' }}">
+<meta name="docsearch:amethyst_pagetype_navigation" content="1">
+{% endif %}
+
 {% endcapture -%}
 {{ opengraph | strip_newlines }}

data/_includes/search.html

@@ -1,14 +1,6 @@
-<form class="site-search" id="site-search-form" action="https://duckduckgo.com">
-<label class="screen-reader-text" for="aa-search-input">Search</label>
-<input type="search" name="q" id="aa-search-input" class="aa-input-search" placeholder="Search..." autocomplete="off">
-<input type="hidden" name="sites" value="{{ site.url | remove_first: 'http://' | remove_first: 'https://' }}">
-<svg class="aa-input-icon" viewBox="654 -372 1664 1664" height="20">
-    <path d="M1806,332c0-123.3-43.8-228.8-131.5-316.5C1586.8-72.2,1481.3-116,1358-116s-228.8,43.8-316.5,131.5  C953.8,103.2,910,208.7,910,332s43.8,228.8,131.5,316.5C1129.2,736.2,1234.7,780,1358,780s228.8-43.8,316.5-131.5  C1762.2,560.8,1806,455.3,1806,332z M2318,1164c0,34.7-12.7,64.7-38,90s-55.3,38-90,38c-36,0-66-12.7-90-38l-343-342  c-119.3,82.7-252.3,124-399,124c-95.3,0-186.5-18.5-273.5-55.5s-162-87-225-150s-113-138-150-225S654,427.3,654,332  s18.5-186.5,55.5-273.5s87-162,150-225s138-113,225-150S1262.7-372,1358-372s186.5,18.5,273.5,55.5s162,87,225,150s113,138,150,225  S2062,236.7,2062,332c0,146.7-41.3,279.7-124,399l343,343C2305.7,1098.7,2318,1128.7,2318,1164z"/>
-</svg>
+<form role="search" class="tsmb-form"{%- if site.amethyst.typesense.search_only_api_key -%} data-origin="{{ site.amethyst.typesense.origin | escape }}" data-collection="{{ site.amethyst.typesense.collection | escape }}" data-key="{{ site.amethyst.typesense.search_only_api_key | escape }}" data-foot="true"{%- endif -%} action="https://duckduckgo.com">
+    <input type="search" name="q" aria-label="Search" placeholder="Search..." autocomplete="off">
+    <input type="hidden" name="sites" value="{{ site.url | remove_first: 'http://' | remove_first: 'https://' }}">
 </form>
 
-{%- comment -%}
 
-See also search-js.html
-
-{%- endcomment -%}

data/_includes/version.html

@@ -22,7 +22,7 @@ Parameters:
 {%- endif -%}
 
 {%- if include.version == "unreleased" -%}
-not yet released
+not yet released<span class="sep">.</span>
 {%- else -%}
-{{ include.label }}: {% if site.amethyst.release_base %}<a href="{{ site.amethyst.release_base }}{{ _full_version | escape }}">{{ include.version | escape }}</a>{% else %}{{ include.version | escape }}{% endif %}
+{{ include.label }}: {% if site.amethyst.release_base %}<a href="{{ site.amethyst.release_base }}{{ _full_version | escape }}">{{ include.version | escape }}</a>{% else %}{{ include.version | escape }}{% endif %}<span class="sep">.</span>
 {%- endif -%}

data/_layouts/group.html

@@ -3,6 +3,7 @@ layout: page-api
 amethyst:
   toc: false
   prepend_description_heading: false
+  pagetype: navigation
 
 # Parameters:
 #

data/_layouts/page-api.html

@@ -27,29 +27,38 @@ do that here for convenience.
 {%- endunless -%}
 <div class="main main--columns wrapper">
 <div class="content" role="main">
+<article>
+    <header>
     <h1>{{ page.title }}</h1>
-    {%- if page.version_added or page.version_deprecated -%}
+    {% if page.groups -%}
+    <p class="post-meta">Categories: {% comment %} space {% endcomment -%}
+        {%- for group in page.groups -%}
+            {%- if page.groups.first != group %}, {% endif -%}
+            {%- assign group_page = site.pages | where: "layout", "group" | where: "group", group | first -%}
+            <a class="category" href="{{ group_page.url | relative_url }}">{{ group_page.title | escape }}</a>
+        {%- endfor -%}
+    .</p>
+    {%- endif %}
+    </header>
+    {% if page.version_added or page.version_deprecated -%}
         {%- assign warning = false -%}
         {%- if page.version_added == "unreleased" or page.version_deprecated or page.version_removed -%}
             {%- assign warning = true -%}
         {%- endif -%}
-
-    <p class="version-details{% if warning %} note--warning{% endif %}">
-        {%- capture lines -%}
-            {%- if page.version_added %}
-                {% include version.html version=page.version_added label="version added" %}
-            {%- endif -%}
-            {%- if page.version_deprecated %}
-                {% include version.html version=page.version_deprecated label="deprecated" %}
-            {%- endif -%}
-            {%- if page.version_removed %}
-                {% include version.html version=page.version_removed label="removed" %}
-            {%- endif -%}
-        {%- endcapture -%}
-        {{ lines | strip | newline_to_br }}
-    </p>
+        <p class="version-details">
+        {%- if page.version_added %}
+            {% include version.html version=page.version_added label="version added" %}
+        {%- endif -%}
+        {%- if page.version_deprecated %}
+            {% include version.html version=page.version_deprecated label="deprecated" %}
+        {%- endif -%}
+        {%- if page.version_removed %}
+            {% include version.html version=page.version_removed label="removed" %}
+        {%- endif -%}
+        </p>
     {%- endif %}
-    {{- content }}
+    {{ content }}
+</article>
 </div>
 {%- assign toc = true -%}
 {%- if layout.amethyst.toc == false -%}

data/_layouts/post.html

@@ -3,15 +3,15 @@ layout: wrapper
 ---
 
 <div class="main main--columns wrapper">
-<div class="content">
-	<article class="content">
+<div class="content" role="main">
+<article>
 	<header>
 		<h1>{{ page.title | escape }}</h1>
 		{%- assign date_format = site.amethyst.date_format | default: "%e %B %Y" -%}
 		<p class="post-meta byline">Posted on <a href="{{ page.url | relative_url }}" rel="bookmark"><time itemprop="pubdate" datetime="{{ page.date | date_to_xmlschema }}">{{ page.date | date: date_format }}</time></a>{% if page.author %} by <span class="vcard"><span class="fn n" rel="author">{{ page.author | escape }}</span></span>{% endif %}</p>
 	</header>
 	{{ content }}
-	</article>
+</article>
 {%- comment -%}
 Support basic read-only rendering of imported comments.
 

data/_layouts/posts-archive.html

@@ -1,5 +1,7 @@
 ---
 layout: wrapper
+amethyst:
+  pagetype: navigation
 ---
 
 <div class="main main--columns wrapper">

data/_layouts/posts-author.html

@@ -1,5 +1,7 @@
 ---
 layout: wrapper
+amethyst:
+  pagetype: navigation
 ---
 
 <div class="main main--columns wrapper">

data/_layouts/posts-tag.html

@@ -1,5 +1,7 @@
 ---
 layout: wrapper
+amethyst:
+  pagetype: navigation
 ---
 
 <div class="main main--columns wrapper">

data/_layouts/posts-year.html

@@ -1,5 +1,7 @@
 ---
 layout: wrapper
+amethyst:
+  pagetype: navigation
 ---
 
 <div class="main main--columns wrapper">

data/_layouts/posts.html

@@ -1,5 +1,8 @@
 ---
 layout: wrapper
+amethyst:
+  pagetype: navigation
+  robots: index
 ---
 
 <div class="main main--columns wrapper">

data/_layouts/wrapper.html

@@ -15,9 +15,7 @@
                 {{ site.title | escape }}
                 {%- endif -%}
             </a>
-            {%- if site.amethyst.algolia.search_only_api_key -%}
-                {%- include search.html -%}
-            {%- endif -%}
+            {%- include search.html -%}
             <nav class="site-nav"><ul class="site-nav-list">
                 {%- for item in site.data.sitenav -%}
                     <li class="site-nav-item{%- if item.sub %} has-sub-list{% endif %}">
@@ -35,8 +33,7 @@
                 {%- endfor -%}
             </ul></nav>
             <div class="site-toggles">
-                {%- if site.amethyst.algolia.search_only_api_key %}
-                <button class="search-toggle toggle" data-opens=".site-search" aria-expanded="false">
+                <button class="search-toggle toggle" aria-expanded="false">
                     <span class="screen-reader-text">Search</span>
                     <svg class="icon aa-input-icon" aria-hidden="true" viewBox="654 -372 1664 1664" height="20">
                         <path d="M1806,332c0-123.3-43.8-228.8-131.5-316.5C1586.8-72.2,1481.3-116,1358-116s-228.8,43.8-316.5,131.5  C953.8,103.2,910,208.7,910,332s43.8,228.8,131.5,316.5C1129.2,736.2,1234.7,780,1358,780s228.8-43.8,316.5-131.5  C1762.2,560.8,1806,455.3,1806,332z M2318,1164c0,34.7-12.7,64.7-38,90s-55.3,38-90,38c-36,0-66-12.7-90-38l-343-342  c-119.3,82.7-252.3,124-399,124c-95.3,0-186.5-18.5-273.5-55.5s-162-87-225-150s-113-138-150-225S654,427.3,654,332  s18.5-186.5,55.5-273.5s87-162,150-225s138-113,225-150S1262.7-372,1358-372s186.5,18.5,273.5,55.5s162,87,225,150s113,138,150,225  S2062,236.7,2062,332c0,146.7-41.3,279.7-124,399l343,343C2305.7,1098.7,2318,1128.7,2318,1164z"/>
@@ -44,16 +41,17 @@
                 </button>
                 <script type="module">
                 const searchToggle = document.querySelector('.search-toggle');
-                const searchToggleOpens = document.querySelector(searchToggle.dataset.opens);
+                const searchForm = document.querySelector('form[role=search]');
+                const searchInput = searchForm.querySelector('input[type=search]');
                 searchToggle.addEventListener('click', () => {
-                    const state = searchToggle.classList.contains('opened');
-                    searchToggle.classList.toggle('opened', !state);
-                    searchToggle.setAttribute('aria-expanded', !state);
-                    searchToggleOpens.classList.toggle('opened', !state);
-                    searchToggleOpens.setAttribute('aria-expanded', !state);
+                    const newState = searchToggle.getAttribute('aria-expanded') !== 'true';
+                    searchToggle.setAttribute('aria-expanded', String(newState));
+                    searchForm.style.display = newState ? 'block' : '';
+                    if (newState) {
+                        searchInput.focus();
+                    }
                 });
                 </script>
-                {%- endif %}
                 <button class="nav-toggle toggle" data-opens=".site-nav" aria-expanded="false">
                     <span class="screen-reader-text">Menu</span>
                     <svg class="icon icon-nav-toggle" aria-hidden="true" viewBox="0 0 100 100" height="20">
@@ -103,8 +101,18 @@
             </p>
         </div>
     </footer>
-{%- if site.amethyst.algolia.search_only_api_key -%}
-    {%- include search-js.html -%}
+{%- comment -%}
+
+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 -%}
+{%- if site.amethyst.typesense.search_only_api_key -%}
+<script defer type="module" src="{{ '/assets/typesense-minibar.js' | file_version_query | relative_url }}"></script>
 {%- endif -%}
 </body>
 </html>