jekyll-theme-amethyst 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 885f5b7a5ae2e9b5997b2fb05ef3cd16d41d836da975e255bd98f28b184e2b5d
-  data.tar.gz: a483603a8616df9defba29971850177b4a29697d764af354f04679039f6e8297
+  metadata.gz: d478567d792fb9752288273d79106286df6ef6ef3031d87fdcf16d63020c0d7d
+  data.tar.gz: 938cf6b1fe0b22eecb926cc6dc4315e27949e644c3682df2312fc3e90749f409
 SHA512:
-  metadata.gz: 69aba6c9b3385f9f11fa03752747f03168481ce74c9e8d9148da623b14fd1292f2db5ed44bf6d1149921ecdecf7974147a74349d506fcc3b0173ed749bdc0d61
-  data.tar.gz: 20d6ab32044f7ad93d4e358f32d95921ab2b05df7586412fe98c3b037e3026d22be8241531842eea08c1816046b1ecf8eed633e3defa1fc676281e49f6b1c778
+  metadata.gz: 581e0dd5940ff83d59bddaa0ffa0ccd2e03de9c3359cf2e2b89a101d50d54e2d1613ec3af8ae197588a8e77c30812066c5e1fc1c0bb15537914ba0f1533e6ab1
+  data.tar.gz: 404fe3d0b4e3abe29168e9a8e644d6e5f482e821c4b05eec34d30e3c976bacbb73f78ed1b0d2e639f8a05438ab9d234ee7dedc63de19e7c21fa26b00392581df

data/_layouts/group.html

@@ -2,6 +2,7 @@
 layout: page-api
 amethyst:
   toc: false
+  prepend_description_heading: false
 
 # 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/_sass/amethyst.scss

@@ -805,6 +805,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.1"
   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.1
 platform: ruby
 authors:
 - Timo Tijhof