just-the-docs 0.10.0 → 0.10.2

data/README.md

@@ -32,7 +32,7 @@ More specifically, the created site:
 
 Other than that, you're free to customize sites that you create with the template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
 
-### Use RubyGems
+### Use as a Ruby Gem
 
 Alternatively, you can install the theme as a Ruby Gem, without creating a new site.
 
@@ -48,17 +48,11 @@ And add this line to your Jekyll site's `_config.yml`:
 theme: just-the-docs
 ```
 
-And then execute:
+And then install all relevant dependencies:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install just-the-docs
-
-Alternatively, you can run it inside Docker while developing your site
-
-    $ docker-compose up
+```shell
+$ bundle
+```
 
 ## Usage
 
@@ -88,8 +82,6 @@ Bug reports, proposals of new features, and pull requests are welcome on GitHub
 
 To set up your environment to develop this theme: fork this repo, the run `bundle install` from the root directory.
 
-A modern [devcontainer configuration](https://code.visualstudio.com/docs/remote/containers) for VSCode is included.
-
 Your theme is set up just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
 
 When this theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be included in the gem.

data/_includes/components/breadcrumbs.html

@@ -11,14 +11,14 @@
 
 {%- if page.url != "/" and page.parent and page.title -%}
 
-{%- capture nav_list_link -%}
-<a href="{{ page.url | relative_url }}" class="nav-list-link">
-{%- endcapture -%}
-
 {%- capture site_nav -%}
 {%- include_cached components/site_nav.html all=true -%}
 {%- endcapture -%}
 
+{%- capture nav_list_link -%}
+<a href="{{ page.url | relative_url }}" class="nav-list-link">
+{%- endcapture -%}
+
 {%- capture nav_list_simple -%}
 <ul class="nav-list">
 {%- endcapture -%}

data/_includes/components/children_nav.html

@@ -11,23 +11,24 @@
 {%- comment -%}
   Whether a page has any children is checked efficiently by inspecting the cached
   site_nav. If the page has no children, nav_children is set to an empty array;
-  otherwise nav_children is left unset.
+  otherwise nav_children is left unset. (The site_nav is rendered the first time
+  it is included, and that may overwrite various variables.)
 {%- endcomment -%}
 
 {%- if page.has_children == false -%}
   {%- assign nav_children = "" | split: "" -%}
 {%- else -%}
 
+  {%- capture site_nav -%}
+  {%- include_cached components/site_nav.html all=true -%}
+  {%- endcapture -%}
+
   {%- assign nav_children = nil -%}
 
   {%- capture nav_list_link -%}
   <a href="{{ page.url | relative_url }}" class="nav-list-link">
   {%- endcapture -%}
 
-  {%- capture site_nav -%}
-  {%- include_cached components/site_nav.html all=true -%}
-  {%- endcapture -%}
-
   {%- capture nav_list_simple -%}
   <ul class="nav-list">
   {%- endcapture -%}

data/_includes/components/footer.html

@@ -1,7 +1,7 @@
 {% capture footer_custom %}
   {%- include footer_custom.html -%}
 {% endcapture %}
-{% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link %}
+{% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link or site.back_to_top %}
   <hr>
   <footer>
     {% if site.back_to_top %}

data/_includes/components/nav/links.html

@@ -13,7 +13,7 @@
   {%- if include.all == true or node.nav_exclude != true -%}
 
   {%- if include.ancestors contains node.title -%}
-  
+
     <li class="nav-list-item">
       <a href="{{ node.url | relative_url }}" class="nav-list-link"> ∞ </a>
     </li>
@@ -26,12 +26,12 @@
     {%- endcapture -%}
 
   {%- else -%}
-  
+
     {%- include components/nav/children.html node=node ancestors=include.ancestors all=include.all -%}
 
     <li class="nav-list-item">
       {%- if nav_children.size >= 1 -%}
-      <button class="nav-list-expander btn-reset" aria-label="toggle items in {{ node.title }} category" aria-pressed="false">
+      <button class="nav-list-expander btn-reset" aria-label="{{ node.title }} submenu" aria-expanded="false">
         <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
       </button>
       {%- endif -%}
@@ -44,9 +44,9 @@
         {%- include components/nav/links.html pages=nav_children ancestors=nav_ancestors all=include.all -%}
       {%- endif -%}
     </li>
-  
+
   {%- endif -%}
-  
+
   {%- endif -%}
   {%- endfor -%}
 </ul>

data/_includes/components/search_header.html

@@ -2,8 +2,11 @@
 
 <div class="search" role="search">
   <div class="search-input-wrap">
-    <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="{{ search_placeholder | strip_html | strip }}" aria-label="{{ search_placeholder | strip_html| strip }}" autocomplete="off">
-    <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label>
+    <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="{{ search_placeholder | strip_html | strip }}" autocomplete="off">
+    <label for="search-input" class="search-label">
+      <span class="sr-only">{{ search_placeholder | strip_html | strip }}</span>
+      <svg viewBox="0 0 24 24" class="search-icon" aria-hidden="true"><use xlink:href="#svg-search"></use></svg>
+    </label>
   </div>
   <div id="search-results" class="search-results"></div>
 </div>

data/_includes/components/sidebar.html

@@ -12,7 +12,7 @@
 <div class="side-bar">
   <div class="site-header" role="banner">
     <a href="{{ '/' | relative_url }}" class="site-title lh-tight">{% include title.html %}</a>
-    <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false">
+    <button id="menu-button" class="site-button btn-reset" aria-label="Menu" aria-expanded="false">
       <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg>
     </button>
   </div>

data/_includes/components/site_nav.html

@@ -47,7 +47,7 @@
             <ul class="nav-list nav-category-list">
               <li class="nav-list-item">
                 {%- if collection.size > 0 -%}
-                <button class="nav-list-expander btn-reset" aria-label="Toggle collection {{ collection_value.name }}" aria-pressed="false">
+                <button class="nav-list-expander btn-reset" aria-label="{{ collection_value.name }} collection" aria-expanded="false">
                   <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
                 </button>
                 {%- endif -%}

data/_includes/css/activation.scss.liquid

@@ -20,6 +20,10 @@
   - The other two rules ensure that all folding collections are expanded.
 {%- endcomment -%}
 
+{%- capture site_nav -%}
+{%- include_cached components/site_nav.html -%}
+{%- endcapture -%}
+
 {%- capture activation_no_nav_link %}
     .site-nav ul li a {
       background-image: none;
@@ -39,10 +43,6 @@
 <a href="{{ page.url | relative_url }}" class="nav-list-link">
 {%- endcapture -%}
 
-{%- capture site_nav -%}
-{%- include_cached components/site_nav.html -%}
-{%- endcapture -%}
-
 {%- if site_nav contains nav_list_link -%}
 
   {%- capture nav_list -%}

data/_sass/color_schemes/dark.scss

@@ -12,7 +12,7 @@ $code-linenumber-color: #dee2f7; // OneDarkJekyll .nf for syntax-one-dark-vivid
 $feedback-color: darken($sidebar-color, 3%);
 $table-background-color: $grey-dk-250;
 $search-background-color: $grey-dk-250;
-$search-result-preview-color: $grey-dk-000;
+$search-result-preview-color: $grey-lt-300;
 $border-color: $grey-dk-200;
 
 @import "./vendor/OneDarkJekyll/syntax"; // this is the one-dark-vivid atom syntax theme

data/_sass/color_schemes/light.scss

@@ -11,6 +11,6 @@ $code-background-color: $grey-lt-000 !default;
 $feedback-color: darken($sidebar-color, 3%) !default;
 $table-background-color: $white !default;
 $search-background-color: $white !default;
-$search-result-preview-color: $grey-dk-000 !default;
+$search-result-preview-color: $grey-dk-100 !default;
 
 @import "./vendor/OneLightJekyll/syntax";

data/_sass/layout.scss

@@ -206,7 +206,6 @@ body {
   left: 0;
   padding-top: $sp-4;
   padding-bottom: $sp-4;
-  color: $grey-dk-000;
 
   @include container;
 

data/_sass/print.scss

@@ -10,6 +10,11 @@
     display: none !important;
   }
 
+  hr {
+    margin-top: 1rem;
+    margin-bottom: 1rem;
+  }
+
   .side-bar {
     width: 100%;
     height: auto;

data/_sass/search.scss

@@ -61,7 +61,8 @@
   }
 
   &:focus {
-    outline: 0;
+    outline: 2px solid $link-color;
+    outline-offset: -2px;
 
     + .search-label .search-icon {
       color: $link-color;

data/_sass/utilities/_layout.scss

@@ -22,6 +22,20 @@
   display: none !important;
 }
 
+// Screenreader-only
+
+.sr-only {
+  position: absolute;
+  width: 1px;
+  height: 1px;
+  padding: 0;
+  margin: -1px;
+  overflow: hidden;
+  clip: rect(0, 0, 0, 0);
+  white-space: nowrap;
+  border-width: 0;
+}
+
 @each $media-query in map-keys($media-queries) {
   @for $i from 1 through length($spacers) {
     @include mq($media-query) {

data/assets/js/just-the-docs.js

@@ -32,7 +32,7 @@ function initNav() {
     }
     if (target) {
       e.preventDefault();
-      target.ariaPressed = target.parentNode.classList.toggle('active');
+      target.ariaExpanded = target.parentNode.classList.toggle('active');
     }
   });
 
@@ -48,11 +48,11 @@ function initNav() {
     if (menuButton.classList.toggle('nav-open')) {
       siteNav.classList.add('nav-open');
       mainHeader.classList.add('nav-open');
-      menuButton.ariaPressed = true;
+      menuButton.ariaExpanded = true;
     } else {
       siteNav.classList.remove('nav-open');
       mainHeader.classList.remove('nav-open');
-      menuButton.ariaPressed = false;
+      menuButton.ariaExpanded = false;
     }
   });
 
@@ -258,7 +258,7 @@ function searchLoaded(index, docs) {
       // note: the SVG svg-doc is only loaded as a Jekyll include if site.search_enabled is true; see _includes/icons/icons.html
       var resultDoc = document.createElement('div');
       resultDoc.classList.add('search-result-doc');
-      resultDoc.innerHTML = '<svg viewBox="0 0 24 24" class="search-result-icon"><use xlink:href="#svg-doc"></use></svg>';
+      resultDoc.innerHTML = '<svg viewBox="0 0 24 24" class="search-result-icon" aria-hidden="true"><use xlink:href="#svg-doc"></use></svg>';
       resultTitle.appendChild(resultDoc);
 
       var resultDocTitle = document.createElement('div');

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: just-the-docs
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.2
 platform: ruby
 authors:
 - Patrick Marsceill
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-09 00:00:00.000000000 Z
+date: 2026-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A modern, highly customizable, and responsive Jekyll theme for documentation