jekyll-awesome-nav 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 033420eec75b6786d092924ce18408a536c7ec67c9987924506538186a4cc561
-  data.tar.gz: f7bcf2906a41f300ed37c921c45f18b2fc764edcec95c9b69c1d3efeb4aa8386
+  metadata.gz: e774b814992c440448bfbbd49e3ac507c6e854d6c855cef20f1c8315bbfdcf2e
+  data.tar.gz: dea01e1a09990359b88048bd4ac16df166c3889803920467c8bca09d0b7e224c
 SHA512:
-  metadata.gz: 58e508a035a0993b79f9511c10d1d7104df50c04c7d5a4ec6304e9f51a8677f93d05bb1aafaec98238ad0a2e5b46dd594722518fbc435a011b58855870658c75
-  data.tar.gz: d9ab55d7518df3cb520ef0c566d2a78b27eb269d4e744988895d7c0d1710f0e3c9c672b768cb1c78c80262dc8d06572cf3a79caf2806d993a76eebdd4e78c500
+  metadata.gz: f1314cc3258497190ca58305f91227d79595eb1b051cfcfab6d6406d943017ca936417817dad3919219f0730d8ac91f13e8b78908121eb779cf76146426fccc5
+  data.tar.gz: 0a005443a0997e10642cf718970efc1b1b30f0b4148261d96de45acc2287e9d927b18ea147f7139f3c91a6c139683377cdc6a7d0c72e8e40ac5693584701a108

data/.copier-answers.ci.yml

@@ -1,11 +1,12 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: 97c7f4b
+_commit: v0.7.0-3-g7e5e928
 _src_path: gh:athackst/ci
-automerge_mode: poll
-bump_script_path: ''
+automerge_mode: native
 do_releases: true
 release_template: '## What''s changed
 
 
-    $CHANGES '
+    $CHANGES
+
+    '
 site_generator: none

data/.devcontainer/devcontainer.json

@@ -5,7 +5,7 @@
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
 	"image": "mcr.microsoft.com/devcontainers/base:ubuntu-24.04",
 	"features": {
-		"ghcr.io/devcontainers/features/ruby:1": {
+		"ghcr.io/devcontainers/features/ruby:2": {
 			"version": "3.3.4"
 		}
 	},

data/lib/jekyll/awesome_nav/version.rb

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

data/site/_config.yml

@@ -1,4 +1,4 @@
-theme: jekyll-theme-profile
+theme: jekyll-theme-primerpages
 title: Jekyll Awesome Nav
 description: Folder-based navigation for Jekyll with automatic generation and local subtree overrides.
 repository: PrimerPages/jekyll-awesome-nav

data/site/_layouts/awesome_nav_demo.html

@@ -399,7 +399,11 @@ layout: default
             <ol>
               {% for item in page.breadcrumbs %}
                 <li>
-                  <a href="{{ item.url | relative_url }}">{{ item.title }}</a>
+                  {% if item.url %}
+                    <a href="{{ item.url | relative_url }}">{{ item.title }}</a>
+                  {% else %}
+                    <span>{{ item.title }}</span>
+                  {% endif %}
                 </li>
               {% endfor %}
             </ol>

data/site/docs/.nav.yml

@@ -0,0 +1,7 @@
+nav:
+  - Getting Started: getting-started.md
+  - guides
+  - Examples:
+    - Examples Home: examples/index.md
+    - Basic Folder Navigation: examples/basic-folder-navigation.md
+    - Local Override: examples/local-override.md

data/site/docs/examples/basic-folder-navigation.md

@@ -0,0 +1,26 @@
+---
+title: Basic Folder Navigation
+---
+
+Use plain folders and pages when you want navigation to come directly from the docs tree.
+
+```text
+docs/
+├── index.md
+├── getting-started.md
+└── guides/
+    ├── index.md
+    ├── install.md
+    └── config.md
+```
+
+With no `.nav.yml` files, the plugin turns that structure into sections and pages automatically.
+
+```yaml
+awesome_nav:
+  enabled: true
+  root: docs
+  nav_filename: .nav.yml
+```
+
+This is a good default when the filesystem already reflects the order and grouping you want.

data/site/docs/examples/index.md

@@ -0,0 +1,10 @@
+---
+title: Examples
+---
+
+These examples show common ways to use `jekyll-awesome-nav` in a docs folder.
+
+## Examples
+
+- [Basic Folder Navigation]({{ "/docs/examples/basic-folder-navigation/" | relative_url }}) shows navigation generated from folders and pages.
+- [Local Override]({{ "/docs/examples/local-override/" | relative_url }}) shows a folder-level `.nav.yml` file with curated labels and order.

data/site/docs/examples/local-override.md

@@ -0,0 +1,25 @@
+---
+title: Local Override Example
+---
+
+Add a `.nav.yml` file when one folder needs a curated order or friendlier labels.
+
+```text
+docs/
+└── guides/
+    ├── .nav.yml
+    ├── index.md
+    ├── install.md
+    └── config.md
+```
+
+Example override:
+
+```yaml
+nav:
+  - Guides Home: index.md
+  - Install Guide: install.md
+  - Configuration: config.md
+```
+
+That file replaces the generated navigation for `docs/guides/` only. The rest of the docs tree still uses normal folder-based generation.

data/site/docs/guides/data.md

@@ -31,7 +31,7 @@ children: []
 
 Layouts should treat `children` as optional because leaf pages do not need nested items.
 
-Breadcrumb items stay lightweight and only expose:
+Breadcrumb items stay lightweight. Linked entries include `url`; grouping entries may only include `title`:
 
 ```yaml
 title: Install Guide

data/site/docs/guides/layouts.md

@@ -37,7 +37,13 @@ The plugin writes breadcrumbs to `page.breadcrumbs`.
 <nav aria-label="Breadcrumbs">
   <ol>
     {% for item in page.breadcrumbs %}
-      <li><a href="{{ item.url | relative_url }}">{{ item.title }}</a></li>
+      <li>
+        {% if item.url %}
+          <a href="{{ item.url | relative_url }}">{{ item.title }}</a>
+        {% else %}
+          <span>{{ item.title }}</span>
+        {% endif %}
+      </li>
     {% endfor %}
   </ol>
 </nav>

data/site/docs/index.md

@@ -9,6 +9,7 @@ The plugin does not require collections. It reads pages under the configured `aw
 ## Start here
 
 - [Getting Started]({{ "/docs/getting-started/" | relative_url }}) shows the minimum install and config.
+- [Examples]({{ "/docs/examples/" | relative_url }}) shows a few concrete folder and `.nav.yml` setups.
 - [Layout Integration]({{ "/docs/guides/layouts/" | relative_url }}) shows how to render sidebars, breadcrumbs, and previous/next links.
 - [Configuration]({{ "/docs/guides/config/" | relative_url }}) explains the available plugin settings.
 - [.nav.yml Reference]({{ "/docs/guides/nav-file/" | relative_url }}) documents override syntax, options, and common patterns.
@@ -22,6 +23,10 @@ This documentation site uses a plain `docs/` folder:
 ```text
 docs/
 ├── index.md
+├── examples/
+│   ├── index.md
+│   ├── basic-folder-navigation.md
+│   └── local-override.md
 ├── getting-started.md
 └── guides/
     ├── index.md

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-awesome-nav
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Allison Thackston
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-21 00:00:00.000000000 Z
+date: 2026-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -69,6 +69,10 @@ files:
 - site/_config.yml
 - site/_includes/awesome-nav-tree.html
 - site/_layouts/awesome_nav_demo.html
+- site/docs/.nav.yml
+- site/docs/examples/basic-folder-navigation.md
+- site/docs/examples/index.md
+- site/docs/examples/local-override.md
 - site/docs/getting-started.md
 - site/docs/guides/.nav.yml
 - site/docs/guides/config.md