markdown-navigation

Parse markdown files to generate hierarchical section outlines and extract section content.

2|Updated Jan 27, 2026

Search Tags:#documentation #markdown #cli #navigation #outline #extraction

Ready to run

npx skills add https://github.com/ucirello/sgai --skill markdown-navigation-ucirello

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown-navigation
Source: https://github.com/ucirello/sgai/tree/main/cmd/sgai/skel/.sgai/skills/markdown-navigation
Command: npx skills add https://github.com/ucirello/sgai --skill markdown-navigation-ucirello

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill helps users efficiently navigate and extract content from large Markdown files, eliminating the need to manually scroll or search through extensive documentation.

Core Features & Use Cases

Generate Outline: Provides a hierarchical outline of all section titles within a Markdown file.
Extract Section Content: Extracts the body of a specific section based on its exact name.
Use Case: When reviewing a lengthy README.md or API documentation, quickly generate an outline to jump to relevant sections or extract a specific configuration example.

Quick Start

Use the markdown-navigation skill to get an outline of the file named 'api-reference.md'.

Frequently Asked Questions about markdown-navigation

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

FAQPage Schema

How do I extract a specific section from a large markdown file?▼

To extract a section from a markdown file, you can parse the document using bash scripting with grep and sed to retrieve the body content under a specific header name. This allows you to pull exact configuration examples without scrolling.

Can I generate an outline of headers in a README file?▼

Yes, you can generate an outline of a README file by parsing the markdown to identify all section titles hierarchically. This provides a structural overview of the documentation, helping you navigate directly to relevant sections.

Do I need external libraries to parse markdown files for navigation?▼

No, you do not need external libraries to parse markdown files for navigation. The process utilizes efficient bash scripting with standard command-line text processing tools like grep and sed to extract headers and content.

What is the best way to navigate lengthy API documentation in markdown?▼

The best way to navigate lengthy markdown API documentation is generating a hierarchical outline of section headers to quickly locate relevant parts. You can then extract the exact content of the desired section by specifying its name.

Are there limitations when using bash to extract markdown section content?▼

Using bash to extract markdown section content relies on text matching with grep and sed, meaning extraction requires the exact section name. It is designed for efficient text processing of headers rather than complex semantic parsing.