nav-inject

Injects navigation tables from nav.json into Markdown files in documentation suites.

Updated Apr 9, 2026

Search Tags:#automation #documentation #markdown #navigation #multi-file #sentinels

Ready to run

npx skills add https://github.com/fabioc-aloha/tldr --skill nav-inject

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: nav-inject
Source: https://github.com/fabioc-aloha/tldr/tree/main/.github/skills/nav-inject
Command: npx skills add https://github.com/fabioc-aloha/tldr --skill nav-inject

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Injects a consistent navigation table into every Markdown file within a documentation suite, eliminating manual cross-link maintenance and drift.

Core Features & Use Cases

Consistent cross-document navigation across multi-file documentation suites
Simple nav.json configuration to define documents, labels, and icons
Non-destructive updates: re-injects navigation between sentinels without overwriting existing content

Quick Start

Run the injector in your docs directory to stamp navigation tables into all Markdown files.

Frequently Asked Questions about nav-inject

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automate navigation tables across multiple Markdown files?▼

The mechanism uses nav markers as sentinels in your Markdown files to inject navigation tables non-destructively. It locates these sentinels, inserts the generated content between them, and preserves all surrounding material during updates.

How do I add cross-document navigation without overwriting existing Markdown content?▼

You add cross-document navigation non-destructively by placing nav markers in your files so the injector can update content between sentinels. This approach preserves surrounding material while re-injecting the navigation table as needed.

Can I use a JSON configuration to define labels and icons for Markdown navigation?▼

Yes, you can use a simple nav.json configuration to define documents, labels, and icons for your Markdown navigation. The injector reads this configuration to generate consistent cross-document navigation tables across your suite.

What is the best way to maintain consistent cross-linking in a multi-file documentation set?▼

The best way to maintain consistent cross-linking in a multi-file documentation set is automating the injection of navigation tables. This ensures global navigation remains uniform across governance, guides, and specifications without manual edits.

When should I not use automated navigation injection for Markdown files?▼

You should avoid automated navigation injection if your documentation is not a multi-file suite or lacks consistent nav markers. The tool relies on sentinels and a nav.json configuration to preserve surrounding material during non-destructive updates.