jekyll-awesome-nav 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76b40b8ac598c39b7d6ea9b1235a4089893bd73e52d8722e8a2c4af8115aa468
-  data.tar.gz: d4109676b6da69d8f40d623b55d40087d57c45f46c718fa349116a9080807bf9
+  metadata.gz: 033420eec75b6786d092924ce18408a536c7ec67c9987924506538186a4cc561
+  data.tar.gz: f7bcf2906a41f300ed37c921c45f18b2fc764edcec95c9b69c1d3efeb4aa8386
 SHA512:
-  metadata.gz: 89bb231311898453666edc086e0a54d6593d6c2644749e4f8a021253b0d272bb56f9bb0c522b9eac17314ea94ccd33e0d2289bd01dde5b69fc9f5f95b2b61ec9
-  data.tar.gz: 7c05e014b8ad8ae8d6fc31f3382af750f10bde1d481f1ad1e19def058645c85e6a4db8b95514a674736da12170e2a49d30898a248ed8c4296d526f967257823c
+  metadata.gz: 58e508a035a0993b79f9511c10d1d7104df50c04c7d5a4ec6304e9f51a8677f93d05bb1aafaec98238ad0a2e5b46dd594722518fbc435a011b58855870658c75
+  data.tar.gz: d9ab55d7518df3cb520ef0c566d2a78b27eb269d4e744988895d7c0d1710f0e3c9c672b768cb1c78c80262dc8d06572cf3a79caf2806d993a76eebdd4e78c500

data/.copier-answers.ci.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: 618054b
+_commit: 97c7f4b
 _src_path: gh:athackst/ci
 automerge_mode: poll
 bump_script_path: ''

data/README.md

@@ -65,10 +65,10 @@ awesome_nav:
 
 Each page under the configured root receives:
 
-- `page.awesome_nav`: the full navigation tree rooted at `awesome_nav.root`
+- `page.awesome_nav`: the full navigation tree rooted at `awesome_nav.root`, annotated with `current` and `contains_current`
 - `page.awesome_nav_local`: the local subtree for the page's directory
 - `page.awesome_nav_dir`: the directory supplying the active nav context
-- `page.breadcrumbs`: breadcrumb items derived from the final tree
+- `page.breadcrumbs`: lightweight breadcrumb items with `title` and `url`
 - `page.awesome_nav_previous`: the previous linked nav item, when one exists
 - `page.awesome_nav_next`: the next linked nav item, when one exists
 

data/lib/jekyll/awesome_nav/generator.rb

@@ -46,7 +46,7 @@ module Jekyll
           page_url = Utils.normalize_url(page.url)
           page_entry = result.nav_entry_for(page_url)
 
-          page.data["awesome_nav"] = deep_copy(result.serialized_tree)
+          page.data["awesome_nav"] = deep_copy(result.annotated_tree_for(page_url))
           page.data["awesome_nav_local"] = deep_copy(result.local_nav_for(nav_dir))
           page.data["awesome_nav_dir"] = nav_dir
           page.data["breadcrumbs"] = result.breadcrumbs_for(page)

data/lib/jekyll/awesome_nav/navigation_result.rb

@@ -14,6 +14,10 @@ module Jekyll
         @serialized_tree ||= Serializer.serialize_tree(@tree)
       end
 
+      def annotated_tree_for(page_url)
+        annotate_current(serialized_tree, Utils.normalize_url(page_url)).first
+      end
+
       def serialized_local_nav_map
         @serialized_local_nav_map ||= Serializer.serialize_map(local_nav_nodes)
       end
@@ -42,20 +46,11 @@ module Jekyll
 
       def breadcrumbs_for(page)
         page_url = Utils.normalize_url(page.url)
-        trail = find_trail(serialized_tree, page_url)
+        trail = find_trail(internal_serialized_tree, page_url)
         return root_breadcrumb(page) if trail.nil? && Utils.source_dir_for(page) == @root_dir && Utils.index_page?(page)
         return [] unless trail
 
-        breadcrumbs = trail.filter_map do |item|
-          next if item["title"].to_s.empty?
-
-          crumb = { "title" => item["title"] }
-          crumb["url"] = item["url"] if item["url"]
-          crumb
-        end
-
-        breadcrumbs = trim_root_breadcrumb(breadcrumbs)
-        return breadcrumbs if @root_dir.empty?
+        breadcrumbs = trail.filter_map { |item| breadcrumb_item_for(item) }
 
         prepend_root_breadcrumb(breadcrumbs)
       end
@@ -66,6 +61,10 @@ module Jekyll
 
       private
 
+      def internal_serialized_tree
+        @internal_serialized_tree ||= Serializer.serialize_tree(@tree, include_internal: true)
+      end
+
       def local_nav_nodes
         @local_nav_nodes ||= begin
           map = { @root_dir => @tree.map(&:deep_dup) }
@@ -87,14 +86,12 @@ module Jekyll
       end
 
       def root_breadcrumb(page)
-        title = page.data["nav_title"] || page.data["title"] || Utils.titleize(Utils.last_segment(@root_dir))
-        title = resolved_root_title if title.to_s.empty?
-        [{ "title" => title, "url" => Utils.normalize_url(page.url) }]
+        [{ "title" => root_breadcrumb_title, "url" => Utils.normalize_url(page.url) }]
       end
 
       def prepend_root_breadcrumb(breadcrumbs)
         root_crumb = {
-          "title" => resolved_root_title,
+          "title" => root_breadcrumb_title,
           "url" => Utils.normalize_url(@root_page&.url || "/#{@root_dir}/")
         }
 
@@ -103,25 +100,12 @@ module Jekyll
         [root_crumb] + breadcrumbs
       end
 
-      def trim_root_breadcrumb(breadcrumbs)
-        return breadcrumbs if breadcrumbs.empty?
-
-        root_crumb = {
-          "title" => resolved_root_title,
-          "url" => Utils.normalize_url(@root_page&.url || "/#{@root_dir}/")
-        }
-
-        return breadcrumbs unless same_breadcrumb_url?(breadcrumbs.first, root_crumb)
-
-        breadcrumbs[1..] || []
-      end
-
       def neighbor_map
         @neighbor_map ||= begin
           items = []
           if @root_page
             items << {
-              "title" => resolved_root_title,
+              "title" => root_breadcrumb_title,
               "url" => Utils.normalize_url(@root_page.url)
             }
           end
@@ -158,6 +142,36 @@ module Jekyll
         nil
       end
 
+      def annotate_current(items, target_url)
+        annotated_items = Array(items).map do |item|
+          annotated_children, child_contains_current = annotate_current(item["children"], target_url)
+          current = current_item?(item, target_url)
+          contains_current = child_contains_current || current
+
+          annotated_item = deep_copy(item)
+          annotated_item["current"] = current
+          annotated_item["contains_current"] = contains_current
+          annotated_item["children"] = annotated_children if annotated_item["children"].is_a?(Array)
+          annotated_item
+        end
+
+        [annotated_items, annotated_items.any? { |item| item["contains_current"] }]
+      end
+
+      def breadcrumb_item_for(item)
+        return if item["title"].to_s.empty?
+
+        crumb = { "title" => item["title"] }
+        crumb["url"] = item["url"] if item["url"]
+        crumb
+      end
+
+      def current_item?(item, target_url)
+        return false unless item["url"]
+
+        Utils.normalize_url(item["url"]) == target_url
+      end
+
       def deep_copy(value)
         Marshal.load(Marshal.dump(value))
       end
@@ -168,6 +182,12 @@ module Jekyll
         Utils.normalize_url(left["url"]) == Utils.normalize_url(right["url"])
       end
 
+      def root_breadcrumb_title
+        return "home" if @root_dir.empty?
+
+        resolved_root_title
+      end
+
       def resolved_root_title
         title = @root_page&.data&.fetch("nav_title", nil) ||
                 @root_page&.data&.fetch("title", nil) ||

data/lib/jekyll/awesome_nav/serializer.rb

@@ -18,7 +18,7 @@ module Jekyll
         item = { "title" => node.title }
         item["url"] = node.url if node.url
         item["children"] = serialize_tree(node.children, include_internal: include_internal) if node.section? && node.children.any?
-        item["__dir"] = node.dir if include_internal && node.dir
+        item["__dir"] = node.dir if include_internal && !node.dir.nil?
         item
       end
     end

data/lib/jekyll/awesome_nav/version.rb

@@ -2,7 +2,7 @@
 
 module Jekyll
   module AwesomeNav
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
 
     def self.warn_if_unstamped_version(output = $stderr)
       return unless VERSION == "0.0.0"

data/site/_includes/awesome-nav-tree.html

@@ -3,7 +3,7 @@
     {% if item.url %}
       <a
         href="{{ item.url | relative_url }}"
-        {% if item.url == page.url %}aria-current="page"{% endif %}
+        {% if item.current %}aria-current="page"{% endif %}
       >
         {{ item.title }}
       </a>

data/site/_layouts/awesome_nav_demo.html

@@ -239,6 +239,63 @@ layout: default
     margin-top: 1.25rem;
   }
 
+  .awesome-nav-demo__debug {
+    margin-top: 1.5rem;
+  }
+
+  .awesome-nav-demo__debug details {
+    border-radius: 1.25rem;
+    overflow: hidden;
+  }
+
+  .awesome-nav-demo__debug summary {
+    align-items: center;
+    cursor: pointer;
+    display: flex;
+    font-weight: 800;
+    gap: 0.75rem;
+    justify-content: space-between;
+    list-style: none;
+    padding: 1rem 1.15rem;
+  }
+
+  .awesome-nav-demo__debug summary::-webkit-details-marker {
+    display: none;
+  }
+
+  .awesome-nav-demo__debug-summary-copy {
+    font-size: 0.82rem;
+    font-weight: 600;
+    opacity: 0.82;
+  }
+
+  .awesome-nav-demo__debug-grid {
+    display: grid;
+    gap: 1rem;
+    grid-template-columns: repeat(auto-fit, minmax(16rem, 1fr));
+    padding: 0 1rem 1rem;
+  }
+
+  .awesome-nav-demo__debug-card {
+    border-radius: 1rem;
+    min-width: 0;
+    padding: 0.9rem;
+  }
+
+  .awesome-nav-demo__debug-card h2 {
+    font-size: 0.95rem;
+    margin: 0 0 0.65rem;
+  }
+
+  .awesome-nav-demo__debug-card pre {
+    font-size: 0.78rem;
+    line-height: 1.5;
+    margin: 0;
+    overflow: auto;
+    white-space: pre-wrap;
+    word-break: break-word;
+  }
+
   .awesome-nav-demo__pager a {
     border-radius: 1.25rem;
     display: flex;
@@ -365,6 +422,47 @@ layout: default
         {{ content | inject_anchors }}
       </article>
 
+      <section class="awesome-nav-demo__debug" aria-label="Plugin debug data">
+        <details>
+          <summary>
+            <span>Plugin data</span>
+            <span class="awesome-nav-demo__debug-summary-copy">Resolved page variables for this page</span>
+          </summary>
+
+          <div class="awesome-nav-demo__debug-grid">
+            <section class="awesome-nav-demo__debug-card">
+              <h2><code>page.breadcrumbs</code></h2>
+              <pre>{{ page.breadcrumbs | jsonify }}</pre>
+            </section>
+
+            <section class="awesome-nav-demo__debug-card">
+              <h2><code>page.awesome_nav</code></h2>
+              <pre>{{ page.awesome_nav | jsonify }}</pre>
+            </section>
+
+            <section class="awesome-nav-demo__debug-card">
+              <h2><code>page.awesome_nav_local</code></h2>
+              <pre>{{ page.awesome_nav_local | jsonify }}</pre>
+            </section>
+
+            <section class="awesome-nav-demo__debug-card">
+              <h2><code>page.awesome_nav_dir</code></h2>
+              <pre>{{ page.awesome_nav_dir | jsonify }}</pre>
+            </section>
+
+            <section class="awesome-nav-demo__debug-card">
+              <h2><code>page.awesome_nav_previous</code></h2>
+              <pre>{{ page.awesome_nav_previous | jsonify }}</pre>
+            </section>
+
+            <section class="awesome-nav-demo__debug-card">
+              <h2><code>page.awesome_nav_next</code></h2>
+              <pre>{{ page.awesome_nav_next | jsonify }}</pre>
+            </section>
+          </div>
+        </details>
+      </section>
+
       {% if previous_item or next_item %}
         <nav class="awesome-nav-demo__pager" aria-label="Pagination">
           {% if previous_item %}

data/site/docs/guides/data.md

@@ -8,10 +8,10 @@ The plugin writes navigation data onto each page under the configured docs root.
 
 | Variable | Description |
 | --- | --- |
-| `page.awesome_nav` | Full resolved docs tree. |
+| `page.awesome_nav` | Full resolved docs tree with `current` and `contains_current` state for rendering. |
 | `page.awesome_nav_local` | Navigation items for the current directory context. |
 | `page.awesome_nav_dir` | Directory that supplied the current local nav context. |
-| `page.breadcrumbs` | Breadcrumb entries for the current page. |
+| `page.breadcrumbs` | Lightweight breadcrumb entries for the current page. |
 | `page.awesome_nav_previous` | Previous page in the resolved navigation order. |
 | `page.awesome_nav_next` | Next page in the resolved navigation order. |
 
@@ -19,16 +19,25 @@ For README-indexed directories, these values are computed using the directory in
 
 ## Tree item shape
 
-Navigation entries are hashes with a title, URL, and optional children:
+Navigation entries are hashes with a title, URL, optional children, and current-state flags:
 
 ```yaml
 title: Install Guide
 url: /docs/guides/install/
+current: true
+contains_current: true
 children: []
 ```
 
 Layouts should treat `children` as optional because leaf pages do not need nested items.
 
+Breadcrumb items stay lightweight and only expose:
+
+```yaml
+title: Install Guide
+url: /docs/guides/install/
+```
+
 ## Site variables
 
 The plugin also writes resolved data into `site.config` for advanced theme use:

data/site/docs/guides/layouts.md

@@ -46,14 +46,17 @@ The plugin writes breadcrumbs to `page.breadcrumbs`.
 
 ## Render a sidebar
 
-Use `page.awesome_nav` for the full docs tree:
+Use `page.awesome_nav` for the full docs tree. Each item includes `current` for the exact page match and `contains_current` for the active branch:
 
 ```liquid
 {% raw %}<nav aria-label="Documentation">
   <ul>
     {% for item in page.awesome_nav %}
       <li>
-        <a href="{{ item.url | relative_url }}">{{ item.title }}</a>
+        <a href="{{ item.url | relative_url }}"{% if item.current %} aria-current="page"{% endif %}>{{ item.title }}</a>
+        {% if item.contains_current %}
+          <span class="visually-hidden">(current section)</span>
+        {% endif %}
         {% if item.children %}
           <ul>
             {% for child in item.children %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-awesome-nav
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Allison Thackston
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-19 00:00:00.000000000 Z
+date: 2026-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll