read-software-docs

Fetch and convert HTML documentation pages to Markdown.

Updated Feb 16, 2026
One-click install
npx skills add https://github.com/aselimc/agents_and_skills --skill read-software-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: read-software-docs
Source: https://github.com/aselimc/agents_and_skills/tree/main/.claude/skills/read-software-docs
Command: npx skills add https://github.com/aselimc/agents_and_skills --skill read-software-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires beautifulsoup4, html2text, requests, and includes scripts (resource) components.

What problem does it solve?

This Skill helps users understand and navigate complex software documentation websites, making it easier to learn about APIs, SDKs, and frameworks.

Core Features & Use Cases

  • Fetch Documentation: Retrieves content from any HTML-based documentation site.
  • Link Discovery: Identifies and lists internal links within documentation to help users find relevant pages.
  • Sitemap Generation: Crawls documentation sites to build a hierarchical overview of available content.
  • Markdown Conversion: Converts fetched HTML content into clean, readable Markdown.
  • Use Case: A developer needs to understand how to use a specific function in the NVIDIA Omniverse Kit. They provide the documentation URL, and the Skill fetches the relevant API reference page, extracts the key information, and presents it in an easy-to-understand format.

Quick Start

Use the read-software-docs skill to fetch and display the main content from the documentation page at https://docs.nvidia.com/isaac/isaac_sim/reference/api/core/index.html.

Frequently Asked Questions about read-software-docs

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

FAQPage Schema
How do I extract API reference documentation from a website?

Yes, you can parse documentation from Sphinx, Doxygen, ReadTheDocs, and MkDocs sites. The Skill fetches and navigates any HTML-based documentation website to retrieve the relevant content.

How do I convert HTML documentation pages to Markdown?

Crawling a documentation site to build a sitemap is supported. The Skill identifies internal links and generates a hierarchical overview of available content to help you navigate complex documentation structures.

Does this approach work with ReadTheDocs and MkDocs frameworks?

Yes, you can parse documentation from Sphinx, Doxygen, ReadTheDocs, and MkDocs sites. The Skill fetches and navigates any HTML-based documentation website to retrieve the relevant content.

How do I convert HTML documentation pages to Markdown?

Converting HTML documentation to Markdown is done by fetching the target web page content. The Skill utilizes Python scripts and dependencies like html2text to extract and convert the HTML into clean Markdown format.

How do I generate a sitemap for a software documentation site?

Crawling a documentation site to build a sitemap is supported. The Skill identifies internal links and generates a hierarchical overview of available content to help you navigate complex documentation structures.