jekyll-awesome-nav 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d260f9f2584da9eadd23954eeaea7886a7b4aa76a9ff7ea5e51b96f0968a35c
-  data.tar.gz: fc44438a6db69080c36db2b6d01613438f4d8561d7d7f4b10720ed29f0c15e1a
+  metadata.gz: 01fa08c8a44630c6314fb330db8db6de0977bc66adb8e2c48dd5f127ede6ff8d
+  data.tar.gz: 29964bc8684fc64593bb76b9385ec19706b578aef5ee780155be2f518c50873b
 SHA512:
-  metadata.gz: a2a84a0bbddfb75659facdd03ab3d0561ad4be3cd5e762fe2742501f6bcec9149d521c32b897c05a258c8a719975507e553cbefc73c115801d8f48ea795d7e24
-  data.tar.gz: e141a89da191d1444cdbbf6d23906b4bf7361fb9f782255c4793143a010387c18d98ce90ab62bba19f37444d0c10646885d0de8abe5800ea2f67095abbb4cd6e
+  metadata.gz: d191dc308b3c7b7b2431417f12c4cdfe59b7acb4c2461364beec68a481909b81dad07724405ee2a2a1644203b6bf13705e86f60af8e98b0895363b3a202a5cb1
+  data.tar.gz: ef4ed52b48b7595d0994ff1f19ba64d70d4e81998ea1ded6b14b395f165a11a0ea5efe43bff3de73ebd8c7e35a48a5e06e7ec1054ff2407becfc838e7ceae6ae

data/.copier-answers.ci.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: 7ca8425
+_commit: aac269f
 _src_path: gh:athackst/ci
 automerge_mode: poll
 bump_script_path: ''
@@ -7,6 +7,5 @@ do_releases: true
 release_template: '## What''s changed
 
 
-    $CHANGES
-    '
+    $CHANGES '
 site_generator: none

data/.vscode/tasks.json

@@ -36,7 +36,7 @@
     {
       "label": "Build Docs Site",
       "type": "shell",
-      "command": "bundle exec jekyll build --source site --destination /tmp/jekyll-awesome-nav-site",
+      "command": "bundle exec rake site",
       "options": {
         "cwd": "${workspaceFolder}"
       },
@@ -46,7 +46,7 @@
     {
       "label": "Serve Docs Site",
       "type": "shell",
-      "command": "bundle exec jekyll serve --source site --destination /tmp/jekyll-awesome-nav-site --livereload",
+      "command": "bundle exec rake serve",
       "options": {
         "cwd": "${workspaceFolder}"
       },

data/README.md

@@ -28,6 +28,37 @@ awesome_nav:
   enabled: true
   root: docs
   nav_filename: .nav.yml
+  include:
+    - "**/*.md"
+    - "**/*.html"
+    - "**/*.htm"
+  ignore:
+    - "assets/**"
+```
+
+## Configuration
+
+`awesome_nav` options:
+
+- `enabled` (default: `true`): enable or disable the plugin.
+- `root` (default: `docs`): source directory root to build navigation from.
+- `nav_filename` (default: `.nav.yml`): per-directory override filename.
+- `include` (default: `["**/*.md", "**/*.html", "**/*.htm"]`): source path globs that are eligible for navigation.
+- `ignore` (default: `["assets/**"]`): source path globs excluded from navigation.
+
+`include`/`ignore` apply to source paths in `site.pages` before tree generation. If `include` is set, a page must match
+at least one include pattern to be considered. Ignore patterns are then applied to remove matches.
+
+Example custom filtering:
+
+```yaml
+awesome_nav:
+  root: ""
+  include:
+    - "README.md"
+    - "docs/**/*.md"
+  ignore:
+    - "docs/drafts/**"
 ```
 
 ## Exposed Page Data
@@ -154,7 +185,7 @@ bundle exec jekyll serve --source site
 ```
 
 The docs site renders `page.awesome_nav`, `page.awesome_nav_local`, `page.breadcrumbs`, and previous/next links
-through a small layout in `site/_layouts/docs.html`.
+through a small layout in `site/_layouts/awesome_nav_demo.html`.
 
 ## Development
 

data/Rakefile

@@ -1,11 +1,35 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "fileutils"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |test|
   test.libs << "test"
   test.pattern = "test/**/*_test.rb"
 end
 
+RuboCop::RakeTask.new(:lint)
+
+desc "Build documentation site"
+task :site do
+  sh "bundle exec jekyll build --source site --destination _site"
+end
+
+desc "Serve documentation site"
+task :serve do
+  sh "bundle exec jekyll serve --source site --destination _site --livereload"
+end
+
+desc "Remove local build and cache artifacts"
+task :clean do
+  artifacts = [
+    "_site",
+    ".jekyll-cache",
+    ".sass-cache"
+  ]
+  artifacts.each { |path| FileUtils.rm_rf(path) }
+end
+
 task default: :test

data/lib/jekyll/awesome_nav/config.rb

@@ -6,7 +6,9 @@ module Jekyll
       DEFAULTS = {
         "enabled" => true,
         "root" => "docs",
-        "nav_filename" => ".nav.yml"
+        "nav_filename" => ".nav.yml",
+        "ignore" => ["assets/**"],
+        "include" => ["**/*.md", "**/*.html", "**/*.htm"]
       }.freeze
 
       def initialize(raw_config)
@@ -26,6 +28,21 @@ module Jekyll
       def nav_filename
         @data["nav_filename"].to_s
       end
+
+      def ignore_patterns
+        value = @data["ignore"]
+        return [] if value.nil?
+
+        Array(value).map { |pattern| Utils.normalize_dir(pattern.to_s) }.reject(&:empty?)
+      end
+
+      def include_patterns
+        value = @data["include"]
+        return nil if value.nil?
+
+        patterns = Array(value).map { |pattern| Utils.normalize_dir(pattern.to_s) }.reject(&:empty?)
+        patterns.empty? ? nil : patterns
+      end
     end
   end
 end

data/lib/jekyll/awesome_nav/generator.rb

@@ -4,7 +4,9 @@ module Jekyll
   module AwesomeNav
     class Generator < Jekyll::Generator
       safe true
-      priority :low
+      # Run after low-priority generators (for example jekyll-readme-index),
+      # so synthetic pages are present before nav data assignment.
+      priority :lowest
 
       def generate(site)
         config = Config.new(site.config["awesome_nav"])

data/lib/jekyll/awesome_nav/navigation_result.rb

@@ -85,13 +85,13 @@ module Jekyll
 
       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) }]
       end
 
       def prepend_root_breadcrumb(breadcrumbs)
         root_crumb = {
-          "title" => @root_page&.data&.fetch("nav_title",
-                                             nil) || @root_page&.data&.fetch("title", nil) || Utils.titleize(Utils.last_segment(@root_dir)),
+          "title" => resolved_root_title,
           "url" => Utils.normalize_url(@root_page&.url || "/#{@root_dir}/")
         }
 
@@ -105,7 +105,7 @@ module Jekyll
           items = []
           if @root_page
             items << {
-              "title" => @root_page.data["nav_title"] || @root_page.data["title"] || Utils.titleize(Utils.last_segment(@root_dir)),
+              "title" => resolved_root_title,
               "url" => Utils.normalize_url(@root_page.url)
             }
           end
@@ -145,6 +145,17 @@ module Jekyll
       def deep_copy(value)
         Marshal.load(Marshal.dump(value))
       end
+
+      def resolved_root_title
+        title = @root_page&.data&.fetch("nav_title", nil) ||
+                @root_page&.data&.fetch("title", nil) ||
+                Utils.titleize(Utils.last_segment(@root_dir))
+        if title.to_s.empty? && @root_page
+          basename = File.basename(@root_page.path.to_s, File.extname(@root_page.path.to_s))
+          title = Utils.page_title(@root_page, basename)
+        end
+        title.to_s.empty? ? "Home" : title
+      end
     end
   end
 end

data/lib/jekyll/awesome_nav/page_set.rb

@@ -6,13 +6,20 @@ module Jekyll
       include Enumerable
 
       def initialize(site, config)
+        root_dir = config.root_dir
+        include_patterns = config.include_patterns
+        ignore_patterns = config.ignore_patterns
         @pages = site.pages.select do |page|
+          source_path = Utils.source_path_for(page)
+
           next false if File.basename(page.path) == config.nav_filename
+          next false unless included?(source_path, include_patterns)
+          next false if ignored?(source_path, ignore_patterns)
 
           dir = Utils.source_dir_for(page)
-          dir == config.root_dir || dir.start_with?("#{config.root_dir}/")
+          root_dir.empty? || dir == root_dir || dir.start_with?("#{root_dir}/")
         end
-        @root_dir = config.root_dir
+        @root_dir = root_dir
       end
 
       def each(&block)
@@ -26,6 +33,20 @@ module Jekyll
       def root_page
         @pages.find { |page| Utils.source_dir_for(page) == @root_dir && Utils.index_page?(page) }
       end
+
+      def ignored?(source_path, patterns)
+        patterns.any? do |pattern|
+          File.fnmatch?(pattern, source_path, File::FNM_PATHNAME | File::FNM_DOTMATCH)
+        end
+      end
+
+      def included?(source_path, patterns)
+        return true if patterns.nil?
+
+        patterns.any? do |pattern|
+          File.fnmatch?(pattern, source_path, File::FNM_PATHNAME | File::FNM_DOTMATCH)
+        end
+      end
     end
   end
 end

data/lib/jekyll/awesome_nav/tree_builder.rb

@@ -34,12 +34,12 @@ module Jekyll
           current = child
         end
 
-        basename = File.basename(page.path, File.extname(page.path))
+        basename = File.basename(page_path, File.extname(page_path))
         title = Utils.page_title(page, basename)
         url = Utils.normalize_url(page.url)
 
-        if basename == "index"
-          current.title = title
+        if Utils.index_page?(page)
+          current.title = section_title_for_index(page, basename, current, title)
           current.url = url
           current.path = page_path
           current.filename = File.basename(page_path)
@@ -63,6 +63,14 @@ module Jekyll
         end
       end
 
+      def section_title_for_index(page, basename, current, resolved_title)
+        return resolved_title unless basename.downcase == "readme"
+        return resolved_title if page.data["nav_title"] || page.data["title"]
+        return current.title unless current.title.to_s.empty?
+
+        resolved_title
+      end
+
       def sort_key(child)
         [
           child.section? ? 0 : 1,

data/lib/jekyll/awesome_nav/utils.rb

@@ -63,7 +63,11 @@ module Jekyll
       end
 
       def index_page?(page)
-        File.basename(page.path, File.extname(page.path)) == "index"
+        basename = File.basename(source_path_for(page), File.extname(source_path_for(page))).downcase
+        return true if basename == "index"
+
+        # jekyll-readme-index can map README.* to the directory index URL.
+        basename == "readme" && normalize_url(page.url) == normalize_url(source_dir_for(page))
       end
 
       def source_dir_for(page)

data/lib/jekyll/awesome_nav/version.rb

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

data/site/_config.yml

@@ -15,12 +15,15 @@ nav:
   - name: Getting Started
     url: /docs/getting-started/
 plugins:
-  - jekyll-seo-tag
   - jekyll-awesome-nav
+  - jekyll-seo-tag
+  - jekyll-toc
 awesome_nav:
   enabled: true
   root: docs
   nav_filename: .nav.yml
+toc:
+  max_level: 2 # default: 6
 markdown: kramdown
 defaults:
   - scope:
@@ -30,4 +33,5 @@ defaults:
   - scope:
       path: "docs"
     values:
-      layout: docs
+      layout: awesome_nav_demo
+      toc: true

data/site/_layouts/awesome_nav_demo.html

@@ -1,128 +1,405 @@
 ---
 layout: default
 ---
+{% assign nav_title = page.nav_title | default: page.title %}
+{% assign docs_root = site.awesome_nav.root | default: "docs" %}
+{% assign local_nav = page.awesome_nav_local %}
+{% assign previous_item = page.awesome_nav_previous %}
+{% assign next_item = page.awesome_nav_next %}
+
 <style>
-  .awesome-nav-docs {
+
+  html {
+    scrollbar-gutter: stable;
+  }
+
+  body {
+    overflow-y: scroll;
+  }
+
+  .awesome-nav-demo {
+    min-height: calc(100vh - var(--topbar-height, 0rem));
+    position: relative;
+  }
+
+  .awesome-nav-demo::before {
+    content: "";
+    inset: 0;
+    pointer-events: none;
+    position: absolute;
+  }
+
+  .awesome-nav-demo a {
+    color: inherit;
+  }
+
+  .awesome-nav-demo__wrap {
     display: grid;
     gap: 2rem;
-    grid-template-columns: minmax(14rem, 18rem) minmax(0, 1fr);
-    max-width: 72rem;
+    grid-template-columns: minmax(15rem, 18rem) minmax(0, 1fr) minmax(13rem, 15rem);
     margin: 0 auto;
-    padding: 2rem 1rem;
+    max-width: 82rem;
+    padding: 2rem 1rem 4rem;
+    position: relative;
+    z-index: 1;
   }
 
-  .awesome-nav-docs__sidebar {
+  .awesome-nav-demo__sidebar,
+  .awesome-nav-demo__toc {
     align-self: start;
+    max-height: calc(100vh - var(--topbar-height, 4rem) - 2rem);
+    overflow: auto;
+    padding: 1rem;
     position: sticky;
-    top: 1rem;
+    top: calc(var(--topbar-height, 4rem) + 1rem);
+  }
+
+  .awesome-nav-demo__brand {
+    align-items: center;
+    display: flex;
+    gap: 0.75rem;
+    margin-bottom: 1rem;
+    padding-bottom: 1rem;
+  }
+
+  .awesome-nav-demo__brand-mark {
+    align-items: end;
+    aspect-ratio: 1;
+    display: grid;
+    flex: 0 0 2.75rem;
+    gap: 0.2rem;
+    grid-template-columns: repeat(3, 1fr);
+    padding: 0.55rem;
+  }
+
+  .awesome-nav-demo__brand-mark span {
+    min-height: 0.55rem;
+  }
+
+  .awesome-nav-demo__brand-mark span:nth-child(2) {
+    min-height: 1.45rem;
+  }
+
+  .awesome-nav-demo__brand-mark span:nth-child(3) {
+    min-height: 1.05rem;
+  }
+
+  .awesome-nav-demo__brand strong,
+  .awesome-nav-demo__brand small {
+    display: block;
   }
 
-  .awesome-nav-docs__sidebar ul {
+  .awesome-nav-demo__brand small,
+  .awesome-nav-demo__eyebrow,
+  .awesome-nav-demo__meta {
+    font-size: 0.72rem;
+    font-weight: 800;
+    letter-spacing: 0.12em;
+    text-transform: uppercase;
+  }
+
+  .awesome-nav-demo__tree,
+  .awesome-nav-demo__tree ul,
+  .awesome-nav-demo__local-list,
+  .awesome-nav-demo__local-list li {
     list-style: none;
     margin: 0;
-    padding-left: 0;
+    padding: 0;
   }
 
-  .awesome-nav-docs__sidebar ul ul {
-    margin-top: 0.25rem;
-    padding-left: 1rem;
+  .awesome-nav-demo__tree ul {
+    margin: 0.25rem 0 0.35rem 0.7rem;
+    padding-left: 0.7rem;
   }
 
-  .awesome-nav-docs__sidebar li {
-    margin: 0.25rem 0;
+  .awesome-nav-demo__tree li,
+  .awesome-nav-demo__local-list li {
+    margin: 0.12rem 0;
   }
 
-  .awesome-nav-docs__sidebar a,
-  .awesome-nav-docs__sidebar span {
+  .awesome-nav-demo__tree a,
+  .awesome-nav-demo__tree span,
+  .awesome-nav-demo__local-list a,
+  .awesome-nav-demo__local-list span {
     display: block;
-    padding: 0.25rem 0;
+    line-height: 1.35;
+    overflow-wrap: anywhere;
+    padding: 0.42rem 0.55rem;
+    text-decoration: none;
   }
 
-  .awesome-nav-docs__sidebar a[aria-current="page"] {
+  .awesome-nav-demo__tree span,
+  .awesome-nav-demo__local-list span {
     font-weight: 700;
   }
 
-  .awesome-nav-docs__breadcrumbs ol {
+  .awesome-nav-demo__tree a[aria-current="page"],
+  .awesome-nav-demo__local-list a[aria-current="page"] {
+    font-weight: 800;
+  }
+
+  .awesome-nav-demo__main {
+    min-width: 0;
+  }
+
+  .awesome-nav-demo__hero {
+    margin: 0 0 1.25rem;
+    padding: 1.25rem 0.25rem 0;
+  }
+
+  .awesome-nav-demo__eyebrow {
+    margin: 0 0 0.75rem;
+  }
+
+  .awesome-nav-demo__title {
+    font-size: clamp(2.8rem, 7vw, 5.8rem);
+    letter-spacing: -0.07em;
+    line-height: 0.9;
+    margin: 0;
+    max-width: 12ch;
+  }
+
+  .awesome-nav-demo__breadcrumbs {
+    font-size: 0.9rem;
+    margin-top: 1rem;
+  }
+
+  .awesome-nav-demo__breadcrumbs ol {
     display: flex;
     flex-wrap: wrap;
     gap: 0.25rem;
     list-style: none;
-    margin: 0 0 1rem;
+    margin: 0;
     padding: 0;
   }
 
-  .awesome-nav-docs__breadcrumbs li {
-    margin: 0.25rem;
-  }
-
-  .awesome-nav-docs__breadcrumbs li:not(:last-child)::after {
+  .awesome-nav-demo__breadcrumbs li:not(:last-child)::after {
     content: "/";
     margin-left: 0.25rem;
   }
 
-  .awesome-nav-docs__pager {
-    border-top: 1px solid var(--borderColor-default, #d0d7de);
+  .awesome-nav-demo__mobile-summary {
+    display: none;
+    margin-bottom: 1rem;
+  }
+
+  .awesome-nav-demo__mobile-summary summary {
+    cursor: pointer;
+    font-weight: 800;
+    list-style: none;
+    padding: 0.85rem 1rem;
+  }
+
+  .awesome-nav-demo__mobile-summary summary::-webkit-details-marker {
+    display: none;
+  }
+
+  .awesome-nav-demo__mobile-summary nav {
+    padding: 0.75rem;
+  }
+
+  .awesome-nav-demo__content {
+    padding: clamp(1.25rem, 4vw, 3rem);
+  }
+
+  .awesome-nav-demo__content > h1:first-child {
+    display: none;
+  }
+
+  .awesome-nav-demo__toc h2,
+  .awesome-nav-demo__sidebar h2 {
+    font-size: 0.95rem;
+    margin: 0 0 0.75rem;
+  }
+
+  .awesome-nav-demo__toc {
     display: flex;
-    justify-content: space-between;
+    flex-direction: column;
+    gap: 1.25rem;
+  }
+
+  .awesome-nav-demo__toc-section {
+    padding-bottom: 1.25rem;
+  }
+
+  .awesome-nav-demo__toc-section:last-child {
+    border-bottom: 0;
+    padding-bottom: 0;
+  }
+
+  .awesome-nav-demo__meta {
+    margin: 0.35rem 0 0;
+    overflow-wrap: anywhere;
+  }
+
+  .awesome-nav-demo__pager {
+    display: grid;
     gap: 1rem;
-    margin-top: 3rem;
-    padding-top: 1rem;
+    grid-template-columns: repeat(2, minmax(0, 1fr));
+    margin-top: 1.25rem;
+  }
+
+  .awesome-nav-demo__pager a {
+    border-radius: 1.25rem;
+    display: flex;
+    flex-direction: column;
+    gap: 0.35rem;
+    min-height: 6rem;
+    padding: 1rem;
+    text-decoration: none;
+  }
+
+  .awesome-nav-demo__pager a:last-child {
+    text-align: right;
+  }
+
+  .awesome-nav-demo__pager span {
+    font-size: 0.78rem;
+    font-weight: 800;
+    letter-spacing: 0.08em;
+    text-transform: uppercase;
+  }
+
+  .awesome-nav-demo__pager strong {
+    font-size: 1.1rem;
+  }
+
+  .awesome-nav-demo__empty-state {
+    border-radius: 1.25rem;
+    padding: 1rem;
+  }
+
+  @media (max-width: 68rem) {
+    .awesome-nav-demo__wrap {
+      grid-template-columns: minmax(14rem, 17rem) minmax(0, 1fr);
+    }
+
+    .awesome-nav-demo__toc {
+      display: none;
+    }
   }
 
   @media (max-width: 48rem) {
-    .awesome-nav-docs {
+    .awesome-nav-demo__wrap {
+      display: block;
+      padding-top: 1rem;
+    }
+
+    .awesome-nav-demo__sidebar {
+      display: none;
+    }
+
+    .awesome-nav-demo__mobile-summary {
+      display: block;
+    }
+
+    .awesome-nav-demo__hero {
+      padding-top: 0.5rem;
+    }
+
+    .awesome-nav-demo__title {
+      font-size: clamp(2.6rem, 15vw, 4.2rem);
+    }
+
+    .awesome-nav-demo__pager {
       grid-template-columns: 1fr;
     }
 
-    .awesome-nav-docs__sidebar {
-      position: static;
+    .awesome-nav-demo__pager a:last-child {
+      text-align: left;
     }
   }
 </style>
 
-<div class="awesome-nav-docs">
-  <aside class="awesome-nav-docs__sidebar">
-    <h2>Docs</h2>
-    {% if page.awesome_nav %}
-      <nav aria-label="Documentation">
-        <ul>
-          {% include awesome-nav-tree.html items=page.awesome_nav %}
-        </ul>
-      </nav>
-    {% endif %}
-  </aside>
-
-  <main class="markdown-body">
-    {% if page.breadcrumbs %}
-      <nav class="awesome-nav-docs__breadcrumbs" aria-label="Breadcrumbs">
-        <ol>
-          {% for item in page.breadcrumbs %}
-            <li>
-              <a href="{{ item.url | relative_url }}">{{ item.title }}</a>
-            </li>
-          {% endfor %}
-        </ol>
-      </nav>
-    {% endif %}
-
-    <h1>{{ page.title }}</h1>
-    {{ content }}
-
-    <nav class="awesome-nav-docs__pager" aria-label="Pagination">
-      <div>
-        {% if page.awesome_nav_previous %}
-          <a href="{{ page.awesome_nav_previous.url | relative_url }}">
-            Previous: {{ page.awesome_nav_previous.title }}
-          </a>
-        {% endif %}
+<div class="awesome-nav-demo">
+  <div class="awesome-nav-demo__wrap">
+    <aside class="awesome-nav-demo__sidebar" aria-label="Documentation navigation">
+      <div class="awesome-nav-demo__brand">
+        <span>
+          <strong>{{ site.title | default: "Awesome Nav" }}</strong>
+          <small>{{ docs_root }} navigation</small>
+        </span>
       </div>
-      <div>
-        {% if page.awesome_nav_next %}
-          <a href="{{ page.awesome_nav_next.url | relative_url }}">
-            Next: {{ page.awesome_nav_next.title }}
-          </a>
+
+      {% if page.awesome_nav %}
+        <nav aria-label="Documentation">
+          <ul class="awesome-nav-demo__tree">
+            {% include awesome-nav-tree.html items=page.awesome_nav %}
+          </ul>
+        </nav>
+      {% else %}
+        <p class="awesome-nav-demo__empty-state">Navigation data is not available for this page.</p>
+      {% endif %}
+    </aside>
+
+    <main class="awesome-nav-demo__main">
+      <section class="awesome-nav-demo__hero">
+        <p class="awesome-nav-demo__eyebrow">Awesome nav demo</p>
+        <h1 class="awesome-nav-demo__title">{{ nav_title }}</h1>
+
+        {% if page.breadcrumbs %}
+          <nav class="awesome-nav-demo__breadcrumbs" aria-label="Breadcrumbs">
+            <ol>
+              {% for item in page.breadcrumbs %}
+                <li>
+                  <a href="{{ item.url | relative_url }}">{{ item.title }}</a>
+                </li>
+              {% endfor %}
+            </ol>
+          </nav>
         {% endif %}
-      </div>
-    </nav>
-  </main>
+      </section>
+
+      {% if page.awesome_nav %}
+        <details class="awesome-nav-demo__mobile-summary">
+          <summary aria-label="Browse documentation" title="Browse documentation">&#9776;</summary>
+          <nav aria-label="Documentation">
+            <ul class="awesome-nav-demo__tree">
+              {% include awesome-nav-tree.html items=page.awesome_nav %}
+            </ul>
+          </nav>
+        </details>
+      {% endif %}
+
+      <article class="awesome-nav-demo__content markdown-body">
+        {{ content | inject_anchors }}
+      </article>
+
+      {% if previous_item or next_item %}
+        <nav class="awesome-nav-demo__pager" aria-label="Pagination">
+          {% if previous_item %}
+            <a href="{{ previous_item.url | relative_url }}">
+              <span>Previous</span>
+              <strong>{{ previous_item.title }}</strong>
+            </a>
+          {% else %}
+            <span></span>
+          {% endif %}
+
+          {% if next_item %}
+            <a href="{{ next_item.url | relative_url }}">
+              <span>Next</span>
+              <strong>{{ next_item.title }}</strong>
+            </a>
+          {% else %}
+            <span></span>
+          {% endif %}
+        </nav>
+      {% endif %}
+    </main>
+
+    <aside class="awesome-nav-demo__toc" aria-label="Current navigation context">
+      <section class="awesome-nav-demo__toc-section">
+        <h2>In this article</h2>
+        {% if local_nav %}
+          <nav aria-label="This section">
+            <ul class="awesome-nav-demo__local-list">
+              {{ content | toc_only }}
+            </ul>
+          </nav>
+        {% else %}
+        {% endif %}
+      </section>
+    </aside>
+  </div>
 </div>

data/site/docs/getting-started.md

@@ -55,14 +55,14 @@ The plugin builds navigation from these pages during the normal Jekyll build. Yo
 
 ## Render it
 
-If your theme already supports `jekyll-awesome-nav`, choose that docs layout for pages under your docs root. This site uses its docs layout through defaults:
+If your theme already supports `jekyll-awesome-nav`, choose that docs layout for pages under your docs root. This site uses a small demo layout through defaults:
 
 ```yaml
 defaults:
   - scope:
       path: "docs"
     values:
-      layout: docs
+      layout: awesome_nav_demo
 ```
 
 If your theme does not support it yet, use the examples in [Layout Integration]({{ "/docs/guides/layouts/" | relative_url }}) to wire the data into your own layout.

data/site/docs/guides/config.md

@@ -9,6 +9,12 @@ awesome_nav:
   enabled: true
   root: docs
   nav_filename: .nav.yml
+  include:
+    - "**/*.md"
+    - "**/*.html"
+    - "**/*.htm"
+  ignore:
+    - "assets/**"
 ```
 
 ## Options
@@ -18,6 +24,10 @@ awesome_nav:
 | `enabled` | `true` | Turns generation on or off. |
 | `root` | `docs` | Folder that contains your documentation pages. |
 | `nav_filename` | `.nav.yml` | Filename used for local subtree overrides. |
+| `include` | `["**/*.md", "**/*.html", "**/*.htm"]` | Source path globs eligible for nav generation. |
+| `ignore` | `["assets/**"]` | Source path globs excluded from nav generation. |
+
+`include` is evaluated first, then `ignore` removes matches.
 
 ## Page titles
 

data/site/docs/guides/data.md

@@ -15,6 +15,8 @@ The plugin writes navigation data onto each page under the configured docs root.
 | `page.awesome_nav_previous` | Previous page in the resolved navigation order. |
 | `page.awesome_nav_next` | Next page in the resolved navigation order. |
 
+For README-indexed directories, these values are computed using the directory index URL (for example `/ros2/`) rather than a nested `README` leaf item.
+
 ## Tree item shape
 
 Navigation entries are hashes with a title, URL, and optional children:
@@ -37,4 +39,6 @@ The plugin also writes resolved data into `site.config` for advanced theme use:
 | `site.awesome_nav_local_map` | Local navigation lookup by directory. |
 | `site.awesome_nav_files` | Loaded `.nav.yml` data. |
 
+When the site uses `jekyll-readme-index`, generated README index pages are included in these resolved structures because awesome-nav runs after low-priority generators.
+
 Most layouts should prefer the `page.*` variables because they are already scoped to the current page.

data/site/docs/guides/install.md

@@ -47,7 +47,7 @@ defaults:
   - scope:
       path: "docs"
     values:
-      layout: docs
+      layout: awesome_nav_demo
 ```
 
 The plugin generates the data. The layout decides how that data looks.

data/site/docs/guides/layouts.md

@@ -4,7 +4,7 @@ title: Layout Integration
 
 `jekyll-awesome-nav` generates navigation data. Your layout renders it.
 
-This site uses its own small layout at `site/_layouts/docs.html`, with a recursive include at `site/_includes/awesome-nav-tree.html`.
+This site uses its own small demo layout at `site/_layouts/awesome_nav_demo.html`, with a recursive include at `site/_includes/awesome-nav-tree.html`.
 
 You can use those files as a starting point when wiring the same data into another Jekyll theme.
 
@@ -17,7 +17,7 @@ defaults:
   - scope:
       path: "docs"
     values:
-      layout: docs
+      layout: awesome_nav_demo
 ```
 
 Inside that layout, check for generated navigation before rendering plugin-specific UI:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-awesome-nav
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Allison Thackston
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-06 00:00:00.000000000 Z
+date: 2026-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -67,7 +67,6 @@ files:
 - lib/jekyll/awesome_nav/utils.rb
 - lib/jekyll/awesome_nav/version.rb
 - site/_config.yml
-- site/_includes/awesome-nav-demo-tree.html
 - site/_includes/awesome-nav-tree.html
 - site/_layouts/awesome_nav_demo.html
 - site/docs/getting-started.md

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

@@ -1,15 +0,0 @@
-{% for item in include.items %}
-  <li>
-    <a
-      href="{{ item.url | relative_url }}"
-      {% if item.url == page.url %}aria-current="page"{% endif %}
-    >
-      {{ item.title }}
-    </a>
-    {% if item.children %}
-      <ul>
-        {% include awesome-nav-demo-tree.html items=item.children %}
-      </ul>
-    {% endif %}
-  </li>
-{% endfor %}