jekyll-theme-amethyst 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 885f5b7a5ae2e9b5997b2fb05ef3cd16d41d836da975e255bd98f28b184e2b5d
-  data.tar.gz: a483603a8616df9defba29971850177b4a29697d764af354f04679039f6e8297
+  metadata.gz: 68cfabbda5545392278fc9d9c2cb3474eff1887f8767d5a5b9139ca0704dbb19
+  data.tar.gz: 6b51b157d9a5f17b4827014c17eb720c499ea1aef854701ab4a1e44aaf07def9
 SHA512:
-  metadata.gz: 69aba6c9b3385f9f11fa03752747f03168481ce74c9e8d9148da623b14fd1292f2db5ed44bf6d1149921ecdecf7974147a74349d506fcc3b0173ed749bdc0d61
-  data.tar.gz: 20d6ab32044f7ad93d4e358f32d95921ab2b05df7586412fe98c3b037e3026d22be8241531842eea08c1816046b1ecf8eed633e3defa1fc676281e49f6b1c778
+  metadata.gz: e123815db6ee3f4ccc22520372a2818946e4ddab08602644c5fcd0fc66387079c88dd3c0eef81074df51bcb85c32bceab2f577a6c74a80e4af4dd25de4568b58
+  data.tar.gz: d729d127294a7f520a565c389cc2679a674f339761e0f4c5d5ee992cbf62abdf9e19a155282796fdf1cb834e4088f6db0dbb894c9d3f7e7fdfd6ae6477e1f4a3

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

@@ -1,13 +1,25 @@
 name: Update search index
 on:
+  # For Algolia, we can update search right away in parallel
+  # with the github-pages build, since it pushes content
+  # into the index from the local working directory.
   push:
-    branches:
-      - main
+   branches:
+     - main
+  # For MeiliSearch, we crawl the site after it has been
+  # built and published by the github-pages workflow
+  workflow_run:
+    workflows:
+      - github-pages
+    types:
+      - completed
+  # Or manually
+  workflow_dispatch:
 
 jobs:
   run:
-    name: Update search index
-    runs-on: ubuntu-18.04
+    name: Algolia
+    runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
 

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/.meilisearch.json

@@ -0,0 +1,20 @@
+{
+  "index_uid": "jekyll-theme-amethyst",
+  "start_urls": ["https://qunitjs.github.io/jekyll-theme-amethyst/"],
+  "stop_urls": [],
+  "selectors": {
+  	"default": {
+      "lvl0": {
+        "selector": ".sidebar-title-open",
+        "global": true,
+        "default_value": "Documentation"
+      },
+      "lvl1": "h1",
+      "lvl2": "h2",
+      "lvl3": "h3",
+      "lvl4": "h4",
+      "lvl5": "h5",
+      "content": "p,li,tr,pre"
+    }
+  }
+}

data/_config.yml

@@ -47,7 +47,7 @@ amethyst:
   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
+    search_only_api_key: f93ac48385f4f5866ffe9227829b329e
 
 
 # Conversion settings
@@ -71,7 +71,7 @@ sass:
 #
 # Docs: https://github.com/algolia/jekyll-algolia
 algolia:
-  application_id: 4HMKKPGKKN
+  application_id: 2Q66ROFTLQ
   index_name: amethyst-demo
   # By default only HTML paragraphs are indexed (and headings, albeit through a different mechanism).
   # * Include list items (similar to paragraphs).

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/_layouts/group.html

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

data/_layouts/page-api.html

@@ -6,9 +6,25 @@ layout: wrapper
 # - version_added: semver string (e.g. "1.2.3"). Can be linked by setting `site.amethyst.release_base`.
 # - version_deprecated: semver string
 # - version_removed: semver string
+# - amethyst.prepend_description_heading: boolean. Default: true.
 #
 ---
 
+{%- comment -%}
+Prepend "Description" header.
+This makes sure the accessibility tree is valid since we generally want to
+use H3 within the top section before later sections like "Changelog" and
+"Examples". But, visually we merge the page title and "Description" together.
+
+Rather than require a special class to be put on every page, we instead
+do that here for convenience.
+{%- endcomment -%}
+{%- unless page.amethyst.prepend_description_heading == false or layout.amethyst.prepend_description_heading == false -%}
+{%- capture content -%}
+<h2 id="description" class="screen-reader-text h-api-desc">Description</h2>
+{{ content }}
+{%- endcapture -%}
+{%- endunless -%}
 <div class="main main--columns wrapper">
 <div class="content" role="main">
     <h1>{{ page.title }}</h1>

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/_sass/amethyst.scss

@@ -306,7 +306,7 @@ table {
     img {
         width: auto;
         height: $size-4;
-        margin-right: $size-spacing / 2;
+        margin-right: calc($size-spacing / 2);
     }
 }
 
@@ -618,7 +618,7 @@ table {
         vertical-align: top;
         // Nominal size is 485x120
         background: url(./logo-algolia.svg);
-        width: (485 / 120) * 0.8rem;
+        width: calc((485 / 120) * 0.8rem);
         height: 0.8rem;
     }
 }
@@ -706,7 +706,7 @@ table {
 
 .sidebar h4 {
     font-size: $size-1;
-    margin: $size-spacing 0 #{$box-spacing / 2} 0;
+    margin: $size-spacing 0 calc($box-spacing / 2) 0;
     padding-left: 4px;
 }
 
@@ -731,7 +731,7 @@ table {
     // Larger and more consistent click target
     display: block;
 
-    padding: $box-spacing / 2 $box-spacing / 2;
+    padding: calc($box-spacing / 2);
 
     color: $color-accent;
     text-decoration: none;
@@ -748,6 +748,10 @@ table {
     position: sticky;
     top: 0;
 }
+.toc-wrapper .toc {
+    max-height: calc( 100vh - 2.5rem );
+    overflow-y: auto;
+}
 .toc,
 .toc ol {
     list-style-type: none;
@@ -805,6 +809,11 @@ table {
 
 /* Layout: page-api */
 
+.h-api-desc {
+    // Let anchor jump to page title
+    margin-top: -6rem;
+}
+
 .version-details {
     font-size: $size-sm;
     font-weight: bold;

data/amethyst.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name     = "jekyll-theme-amethyst"
-  spec.version  = "0.4.0"
+  spec.version  = "0.4.2"
   spec.summary  = "https://github.com/qunitjs/jekyll-theme-amethyst"
   spec.authors  = ["Timo Tijhof", "Trent Willis"]
   spec.files    = `git ls-files -z`.split("\x0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-amethyst
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Timo Tijhof
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2023-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -126,6 +126,7 @@ files:
 - ".github/workflows/github-pages.yaml"
 - ".github/workflows/spider-check.yaml"
 - ".gitignore"
+- ".meilisearch.json"
 - 404.md
 - Gemfile
 - LICENSE.txt
@@ -215,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: https://github.com/qunitjs/jekyll-theme-amethyst