heading-conversion

Convert HTML heading tags into ATX and Setext Markdown formats.

836|66|Updated Feb 3, 2025
One-click install
npx skills add https://github.com/kreuzberg-dev/html-to-markdown --skill heading-conversion
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: heading-conversion
Source: https://github.com/kreuzberg-dev/html-to-markdown/tree/main/.ai-rulez/domains/conversion-algorithms/skills/heading-conversion
Command: npx skills add https://github.com/kreuzberg-dev/html-to-markdown --skill heading-conversion

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill converts HTML heading tags (h1, h2, etc.) into their corresponding Markdown representations, ensuring consistent formatting across different platforms.

Core Features & Use Cases

  • ATX Style Conversion: Generates Markdown headings using the '#' prefix (e.g., # Heading 1).
  • Setext Style Conversion: Supports Setext style headings using underlines for h1 and h2.
  • Preserves Inline Formatting: Maintains bold, italic, and link formatting within headings.
  • Use Case: Convert an HTML article with various heading levels into a Markdown document suitable for README files, blog posts, or documentation.

Quick Start

Convert the provided HTML content into Markdown headings.

Frequently Asked Questions about heading-conversion

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

FAQPage Schema
How do I convert HTML headings to Markdown format?

Converting HTML headings to Markdown involves extracting h1-h6 tags and translating them into ATX or Setext styles. This skill automates that extraction, preserving inline formatting like bold and italic text while adding necessary blank lines for valid document structure.

What is the difference between ATX and Setext Markdown headings?

ATX Markdown headings use '#' prefixes (e.g., `# Heading 1`) for all levels, while Setext headings use underlines for h1 and h2 only. This skill supports both styles, allowing you to choose the format that best suits your documentation needs.

Does converting HTML headings to Markdown preserve inline formatting?

Yes, converting HTML headings to Markdown preserves inline formatting. The skill ensures that bold, italic, and link text within heading tags are accurately maintained in the final Markdown output for cross-platform document compatibility.

When do I need to convert HTML headings into Markdown?

You need to convert HTML headings into Markdown during content migration or when preparing articles for README files, blog posts, and documentation. It ensures consistent heading formatting across different platforms that rely on Markdown syntax.

Can I convert HTML articles into Markdown for README files?

Yes, you can convert HTML articles into Markdown for README files. The skill processes various heading levels and inline formatting, making the resulting Markdown document directly suitable for cross-platform documentation and repository displays.