jekyll-awesome-nav 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d260f9f2584da9eadd23954eeaea7886a7b4aa76a9ff7ea5e51b96f0968a35c
+  data.tar.gz: fc44438a6db69080c36db2b6d01613438f4d8561d7d7f4b10720ed29f0c15e1a
+SHA512:
+  metadata.gz: a2a84a0bbddfb75659facdd03ab3d0561ad4be3cd5e762fe2742501f6bcec9149d521c32b897c05a258c8a719975507e553cbefc73c115801d8f48ea795d7e24
+  data.tar.gz: e141a89da191d1444cdbbf6d23906b4bf7361fb9f782255c4793143a010387c18d98ce90ab62bba19f37444d0c10646885d0de8abe5800ea2f67095abbb4cd6e

data/.copier-answers.ci.yml

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

data/.devcontainer/devcontainer.json

@@ -0,0 +1,35 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	// 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": {
+			"version": "3.3.4"
+		}
+	},
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	"forwardPorts": [
+		// Jekyll server
+		4000,
+		// Live reload server
+		35729
+	],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": ".devcontainer/post-create.sh",
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			"settings": {
+				"rubyLsp.rubyVersionManager": {
+					"identifier": "rvm"
+				}
+			}
+		}
+	}
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.devcontainer/post-create.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+bundle config set --local path 'vendor/bundle'
+
+# Install the version of Bundler.
+if [ -f Gemfile.lock ] && grep "BUNDLED WITH" Gemfile.lock > /dev/null; then
+    cat Gemfile.lock | tail -n 2 | grep -C2 "BUNDLED WITH" | tail -n 1 | xargs gem install bundler -v
+fi
+
+# If there's a Gemfile, then run `bundle install`
+# It's assumed that the Gemfile will install Jekyll too
+if [ -f Gemfile ]; then
+    bundle install
+fi
+
+# Get the current ruby version and set .ruby-version
+ruby_version=$(ruby -v | awk '{print $2}')
+printf %s "$ruby_version" > .ruby-version
+echo "Ruby version $ruby_version set in .ruby-version file"

data/.rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+# Naming cops
+# ----------------------------------------
+Naming/FileName:
+  Exclude:
+    - lib/jekyll-awesome-nav.rb
+
+# Layout cops
+# ----------------------------------------
+Layout/LineLength:
+  Max: 150
+  AllowedPatterns:
+    - '\A# '
+
+# Metrics cops
+# ----------------------------------------
+Metrics/AbcSize:
+  Max: 62
+Metrics/BlockLength:
+  Exclude:
+    - "test/**/*"
+Metrics/ClassLength:
+  Max: 300
+Metrics/CyclomaticComplexity:
+  Max: 12
+Metrics/MethodLength:
+  Max: 31
+Metrics/ModuleLength:
+  Max: 240
+Metrics/ParameterLists:
+  Max: 7
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Style cops
+# ----------------------------------------
+Style/Documentation:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/.vscode/tasks.json

@@ -0,0 +1,70 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Bundle Install",
+      "type": "shell",
+      "command": "bundle install",
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Test",
+      "type": "shell",
+      "command": "bundle exec rake test",
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Lint",
+      "type": "shell",
+      "command": "bundle exec rubocop",
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "group": "build",
+      "problemMatcher": []
+    },
+    {
+      "label": "Build Docs Site",
+      "type": "shell",
+      "command": "bundle exec jekyll build --source site --destination /tmp/jekyll-awesome-nav-site",
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "group": "build",
+      "problemMatcher": []
+    },
+    {
+      "label": "Serve Docs Site",
+      "type": "shell",
+      "command": "bundle exec jekyll serve --source site --destination /tmp/jekyll-awesome-nav-site --livereload",
+      "options": {
+        "cwd": "${workspaceFolder}"
+      },
+      "isBackground": true,
+      "problemMatcher": {
+        "owner": "jekyll",
+        "pattern": {
+          "regexp": ".",
+          "file": 1,
+          "location": 1,
+          "message": 1
+        },
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": ".*Generating.*",
+          "endsPattern": ".*Server address:.*"
+        }
+      }
+    }
+  ]
+}

data/AGENTS.md

@@ -0,0 +1,287 @@
+# AGENTS.md
+
+## Overview
+
+This project implements a Jekyll plugin that provides **folder-based navigation with automatic generation and local overrides**, modeled after MkDocs Material + Awesome Pages behavior.
+
+The plugin builds a **full navigation tree from a configured root directory**, and allows **per-folder `_nav.yml` files to override subtrees**.
+
+---
+
+## Core Design Principles
+
+1. **Convention over configuration**
+
+   * Navigation should work with zero config.
+   * Folder structure defines navigation by default.
+
+2. **Local control**
+
+   * A `_nav.yml` file in a folder overrides navigation for that folder only.
+
+3. **Predictability**
+
+   * No merging or implicit behavior.
+   * Overrides are explicit and replace-only.
+
+4. **Full-tree navigation**
+
+   * Always render the full navigation tree from the root.
+   * Expand current section in UI (handled by theme).
+
+5. **Separation of concerns**
+
+   * Plugin generates data.
+   * Theme handles rendering.
+
+---
+
+## Configuration
+
+Defined in `_config.yml`:
+
+```yaml
+awesome_nav:
+  enabled: true
+  root: docs
+  nav_filename: _nav.yml
+```
+
+### Fields
+
+* `enabled` (bool): enable/disable plugin
+* `root` (string): root directory for navigation
+* `nav_filename` (string): name of override file (default `_nav.yml`)
+
+---
+
+## Navigation Behavior
+
+### 1. Automatic Navigation Generation
+
+* Navigation is generated from `site.pages` under `root`
+* Folder structure determines hierarchy
+* Each directory becomes a section
+* Each page becomes a leaf node
+
+Rules:
+
+* `index.md` defines:
+
+  * section title (fallback: folder name)
+  * section URL
+* Other pages:
+
+  * become leaf items under their directory
+* Titles:
+
+  * `nav_title` → `title` → filename fallback
+
+---
+
+### 2. Full Tree Model
+
+* A single navigation tree is built from the root
+* Every page receives the same tree (`page.awesome_nav`)
+* Tree structure is consistent across all pages
+
+---
+
+### 3. Override Behavior (`_nav.yml`)
+
+* `_nav.yml` overrides navigation for its directory subtree
+* Override replaces generated subtree entirely
+* No merging with parent or generated structure
+
+Resolution:
+
+* While building final tree:
+
+  * if directory has `_nav.yml`, use it
+  * otherwise use generated structure
+
+---
+
+### 4. Override Scope
+
+* Overrides apply only to their directory
+* Parent and sibling sections remain unchanged
+* Overrides cascade downward (children inherit overridden subtree)
+
+---
+
+### 5. No Override Case
+
+* If no `_nav.yml` exists anywhere:
+
+  * navigation is fully auto-generated
+
+---
+
+## Data Exposed to Pages
+
+Each page receives:
+
+### `page.awesome_nav`
+
+* Full navigation tree (root-based, with overrides applied)
+
+### `page.awesome_nav_local`
+
+* Local subtree for the page’s directory
+
+### `page.awesome_nav_dir`
+
+* Directory that provided the active nav (override or root)
+
+### `page.breadcrumbs`
+
+* Array of breadcrumb items:
+
+  ```yaml
+  - title: Guides
+    url: /docs/guides/
+  - title: Install
+    url: /docs/guides/install/
+  ```
+
+---
+
+## Breadcrumb Behavior
+
+* Derived from the final navigation tree
+* Matches the path to the current page
+* Uses nav titles (not filesystem names)
+
+---
+
+## File Structure Expectations
+
+Example:
+
+```text
+docs/
+  index.md
+  getting-started.md
+  guides/
+    install.md
+    config.md
+```
+
+Optional overrides:
+
+```text
+docs/_nav.yml
+docs/guides/_nav.yml
+```
+
+---
+
+## `_nav.yml` Format
+
+```yaml
+- title: Guides
+  url: /docs/guides/
+  children:
+    - title: Install
+      url: /docs/guides/install/
+    - title: Config
+      url: /docs/guides/config/
+```
+
+Rules:
+
+* Must be an array of items
+* Each item:
+
+  * `title` (required)
+  * `url` (optional)
+  * `children` (optional, recursive)
+
+---
+
+## URL Handling
+
+* URLs normalized to:
+
+  * leading slash
+  * trailing slash for directories
+* `index.html` stripped
+* Matching is done on normalized URLs
+
+---
+
+## Sorting Rules
+
+Generated navigation:
+
+1. Sections before pages
+2. Alphabetical by title
+
+Override navigation:
+
+* Order is preserved exactly as written
+
+---
+
+## Page Inclusion Rules
+
+* Only include pages under `root`
+* Exclude `_nav.yml` files from page list
+* Ignore pages outside root entirely
+
+---
+
+## Internal Implementation Notes
+
+* Plugin type: `Jekyll::Generator`
+* Runs after site inventory
+* Does not modify Jekyll collections
+* Works only with `site.pages`
+
+### Key Steps
+
+1. Collect pages under root
+2. Build generated tree
+3. Load `_nav.yml` overrides
+4. Apply overrides to tree (replace subtree)
+5. Assign navigation + breadcrumbs to pages
+
+---
+
+## Non-Goals
+
+* No support for:
+
+  * merging nav structures
+  * multiple nav roots
+  * dynamic runtime nav generation
+  * collection integration
+* No UI rendering logic in plugin
+
+---
+
+## Future Extensions (Optional)
+
+* `nav_title` override in front matter
+* Hidden pages (`nav_exclude`)
+* Ordering via front matter
+* Collapsible state hints
+* Multiple roots
+
+---
+
+## Summary
+
+This plugin provides:
+
+* Automatic navigation from folder structure
+* Full-tree sidebar navigation
+* Local override via `_nav.yml`
+* Breadcrumb generation
+
+Design is intentionally:
+
+* simple
+* predictable
+* aligned with MkDocs-style workflows

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at allison@allisonthackston.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Allison Thackston
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.