markdowndocs 0.11.2 → 0.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28f9775decd9995a54bf22809d3ef0a27cb5c684e4aa068a42592f7723c7ebd8
-  data.tar.gz: 5f1b6adc6bd424e4ef1c872432d11c6d93ea5c18fe1cc25dd389deea7c1c3a5e
+  metadata.gz: 1f1cb7d3191ecb664710cd650b934dc133ba887db48cfd49ec9c7758fbcfaf69
+  data.tar.gz: 7a236c92a2b4d755c882b3c257b2b52b900ceae73312989433ff6ab93d35a1bd
 SHA512:
-  metadata.gz: aca1b149e1727df52bf8ab922291cf9148e0c70867098674e11e5d4d092c278c800bf96017267c43763e1e3b009f998a87ecd4ee7800514d5087770ee33c65b2
-  data.tar.gz: 3f06f7c533c897094139c6d7ea90484314a1a3531fd64c56a9e615896599057ebb2c6165a138d17ba0f85089c10f0e68e259cd6c004e7466035f4bbd225e24ab
+  metadata.gz: '028f7855c0d94dc53fd363f2f8ac34d13c8e417a64f20753fa42aa9b3f07534f9d62f91ba7f1af137cbb9787ed28f5b4680d467fcf4850d30562e7ecca4ae79b'
+  data.tar.gz: 948e320c78060772faf7b4cba7ce6ee66936af28e71d702694d433f801937c872439a7e6becff8dd78c7d6a7573b1097df64b57ed19faf936951ed575bb8a1e2

data/CHANGELOG.md

@@ -5,6 +5,43 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [0.11.4] - 2026-09-23
+
+Two search fixes. Neither changes an API, but the second one asks something of
+apps that have overridden the docs index template.
+
+### Fixed
+
+- **A query typed before the search index arrives is no longer dropped.**
+  `performSearch` returns through `showAll()` while `miniSearch` is still null,
+  and nothing re-read the input once the fetch resolved — so on a slow
+  connection the filter looked dead to anyone who started typing straight away.
+  The controller now re-runs the search as soon as the index is usable. Proved
+  by a browser spec in a host app rather than here: this repo has no
+  JavaScript test harness, and standing one up is tracked separately.
+
+- **The docs index filter no longer hides every card.** `search_index` keys each
+  entry on `path_slug`, but the index template tagged each card with the bare
+  `slug`, and `docs_search_controller` matches a card by comparing the two. A
+  mode-scoped document therefore never matched its own index entry, so any query
+  emptied the page. Cards now carry `path_slug`. Apps that copied
+  `docs/index.html.erb` into their own `app/views/markdowndocs/docs/` need the
+  same change locally — a gem upgrade does not reach an override.
+
+## [0.11.3] - 2026-09-03
+
+### Accessibility
+
+- **The doc page emits one `main` landmark, not two.** `docs/show` wrapped its
+  content column in `<main>`, nesting a second landmark inside the one the host
+  layout (or this engine's own, standalone) already provides. axe reports it as
+  `landmark-no-duplicate-main` and `landmark-main-is-top-level`, and screen
+  readers get two competing "main" destinations on every `/docs/*` page. The
+  column is now a `<div>`; the `<article>` inside still carries the content
+  semantics.
+
 ## [0.11.2] - 2026-07-15
 
 ### Accessibility

data/app/assets/javascripts/markdowndocs/controllers/docs_search_controller.js

@@ -32,6 +32,12 @@ export default class extends Controller {
         }
       })
       this.miniSearch.addAll(docs)
+
+      // A query typed while the index was still loading was dropped:
+      // performSearch returns through showAll() while miniSearch is null, and
+      // nothing re-read the input once the fetch resolved, so the filter looked
+      // dead to anyone who started typing straight away (#42).
+      if (this.hasInputTarget && this.inputTarget.value.trim()) this.performSearch()
     } catch (e) {
       console.warn("Markdowndocs: failed to load search index", e)
     }

data/app/views/markdowndocs/docs/index.html.erb

@@ -56,7 +56,12 @@
                 md:grid-cols-2
                 lg:grid-cols-3">
               <% docs.each do |doc| %>
-                <div <% if @search_enabled %>data-docs-search-target="card" data-slug="<%= doc.slug %>"<% end %>>
+                <%# path_slug, NOT the bare slug: search_index keys every entry on
+                    path_slug, and docs_search_controller matches a card by testing
+                    this attribute against those ids. A mode-scoped document tagged
+                    with its bare slug matches nothing, which hid every card on
+                    every query (#40). %>
+                <div <% if @search_enabled %>data-docs-search-target="card" data-slug="<%= doc.path_slug %>"<% end %>>
                   <%= render "markdowndocs/docs/card", doc: doc %>
                 </div>
               <% end %>

data/app/views/markdowndocs/docs/show.html.erb

@@ -68,8 +68,10 @@
     <!-- Two-column layout -->
     <div class="grid grid-cols-1 gap-8
           lg:grid-cols-12">
-      <!-- Main content -->
-      <main class="lg:col-span-8">
+      <!-- Main content. A grid column, not a landmark: the page's `main` is the
+           host layout's (or this engine's own, when standalone), and a second
+           one nested inside it is a duplicate landmark. -->
+      <div class="lg:col-span-8">
         <article
           tabindex="-1"
           autofocus
@@ -78,7 +80,7 @@
             <%= raw @rendered_content %>
           </div>
         </article>
-      </main>
+      </div>
 
       <!-- Desktop sidebar (hidden on mobile, shown in grid on desktop) -->
       <div class="hidden lg:block lg:col-span-4">

data/lib/markdowndocs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Markdowndocs
-  VERSION = "0.11.2"
+  VERSION = "0.11.4"
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdowndocs
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.4
 platform: ruby
 authors:
 - Dave Chmura
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -114,6 +115,7 @@ metadata:
   homepage_uri: https://github.com/dschmura/markdowndocs
   source_code_uri: https://github.com/dschmura/markdowndocs
   changelog_uri: https://github.com/dschmura/markdowndocs/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,7 +130,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: A drop-in markdown documentation site for Rails apps
 test_files: []