rspress-nav

Configure RSPress navigation bars and sidebars using _nav.json and _meta.json.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/savvy-web/developer-docs --skill rspress-nav
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rspress-nav
Source: https://github.com/savvy-web/developer-docs/tree/main/.claude/skills/rspress-nav
Command: npx skills add https://github.com/savvy-web/developer-docs --skill rspress-nav

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Managing navigation for large documentation sites is error-prone and hard to maintain. This Skill explains how to configure top navigation and per-directory sidebars using _nav.json and _meta.json.

Core Features & Use Cases

  • Navbar Configuration: Place _nav.json in the docs root to define top-level navigation items and nested menus.
  • Sidebar Configuration: Use _meta.json in each directory to configure per-section sidebars with files, dirs, and dividers.
  • Pattern Examples: See samples for auto-generated sidebars, section dividers, and nested navigation patterns.

Quick Start

Create _nav.json in docs/root with top-level items and create _meta.json files in directories to define sidebars. Validate active routes with activeMatch patterns.

Frequently Asked Questions about rspress-nav

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

FAQPage Schema
How do I configure navigation for an RSPress documentation site?

Configure RSPress navigation by creating `_nav.json` at your docs root to define the top navbar, and `_meta.json` files in each directory to set up per-section sidebars. Use fields like text, link, activeMatch for navbar items and type, name, label, collapsible for sidebar entries to structure files, directories, and dividers.

What's the difference between _nav.json and _meta.json in RSPress docs?

`_nav.json` placed at the docs root defines your site's top-level navigation bar with nested menus. `_meta.json` files in each directory configure contextual sidebars for that section, controlling which files and folders appear and how they collapse or link.

Can I create nested collapsible navigation items in RSPress sidebars?

Yes. In `_meta.json`, use the `collapsible` and `collapsed` fields to create nested menu groups that expand and collapse. Structure items hierarchically with the `items` array to build multi-level navigation patterns within each section.

How do I set up active route highlighting in RSPress navbar?

Use the `activeMatch` field in your `_nav.json` navbar configuration to define URL patterns that highlight the current section. This regex-based matching ensures the correct nav item shows as active based on the user's current page route.

What file structure do I need before configuring RSPress navigation?

Place `_nav.json` in your docs root directory and create `_meta.json` files in each subdirectory you want to configure. This structure lets RSPress apply top-level navbar settings globally while allowing per-directory sidebar customization.