github-markdown

Standardize GitHub Flavored Markdown formatting for consistent rendering.

Updated Mar 31, 2026
One-click install
npx skills add https://github.com/dotBeeps/hoard --skill github-markdown
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: github-markdown
Source: https://github.com/dotBeeps/hoard/tree/main/morsels/skills/github-markdown
Command: npx skills add https://github.com/dotBeeps/hoard --skill github-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides clear conventions and practical guidance to ensure Markdown renders as intended on GitHub, avoiding common pitfalls like broken tables, unrendered diagrams, incorrect relative links, and inaccessible images.

Core Features & Use Cases

  • Standard guidance for task lists, nested checkboxes, and completion tracking in issues and PRs.
  • Callout and alert patterns, collapsible sections for long logs, and recommendations for readable tables and code blocks with language tags.
  • Best practices for mermaid diagrams, relative links, image alt text, HTML usage limits, emoji use, footnotes, and anti-patterns to avoid when authoring READMEs, docs, issues, and wiki pages.

Quick Start

Format the repository README using GitHub Flavored Markdown conventions: add task lists where actionable items belong, use collapsible sections for long output, add language-tagged code blocks and simple mermaid diagrams so content renders cleanly on GitHub.

Frequently Asked Questions about github-markdown

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

FAQPage Schema
How do I fix broken tables and unrendered mermaid diagrams in GitHub Markdown?

To format a GitHub README, apply GitHub Flavored Markdown conventions: add task lists for actionable items, use collapsible sections for long output, and insert language-tagged code blocks to ensure content renders cleanly on GitHub.

How do I create collapsible sections for long logs in GitHub issues and PRs?

You create collapsible sections for long logs in GitHub issues and PRs by applying specific GitHub Flavored Markdown formatting conventions. This ensures the extended output remains readable and renders correctly within the platform's interface.

What is the correct way to use task lists and nested checkboxes in GitHub Markdown?

Task lists and nested checkboxes in GitHub Markdown provide standard guidance for completion tracking in issues and PRs. Using correct GitHub Flavored Markdown syntax ensures these actionable items render properly and track progress as intended.

Does GitHub Markdown support callouts, alert patterns, and footnotes?

GitHub Markdown supports callouts, alert patterns, and footnotes through specific GitHub Flavored Markdown conventions. Applying these standard patterns ensures your READMEs, docs, and wiki pages render as intended without relying on unsupported HTML.

Why do my relative links and image alt text fail to render correctly on GitHub?

Relative links and image alt text fail to render correctly on GitHub when they do not follow GitHub Flavored Markdown conventions. Ensuring correct relative link syntax and accessible alt text for images avoids these common rendering pitfalls.