markdown-output

Format GitHub-flavored Markdown for issues, PRs, comments, and documentation.

Updated Aug 8, 2021
One-click install
npx skills add https://github.com/luanzeba/dotfiles --skill markdown-output
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-output
Source: https://github.com/luanzeba/dotfiles/tree/main/skills/markdown-output
Command: npx skills add https://github.com/luanzeba/dotfiles --skill markdown-output

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Crafting and posting GitHub-flavored Markdown content can be error-prone and time-consuming. This skill ensures consistent formatting across issues, PRs, comments, and documentation, reducing manual edits and copy-paste mistakes.

Core Features & Use Cases

  • Formats GitHub-flavored Markdown with proper headings, collapsible sections, code blocks, tables, and alert callouts.
  • Delivers ready-to-paste content to GitHub, local files, or clipboard based on user choice.
  • Use case: generate clean, ready-to-paste content for issues, PRs, or docs with correct GitHub semantics.

Quick Start

Format a new discussion draft into GitHub-ready Markdown and copy it to the clipboard.

Frequently Asked Questions about markdown-output

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

FAQPage Schema
How do I format GitHub issues with collapsible sections and code blocks?

GitHub Markdown formatting applies proper syntax for collapsible sections, code blocks, tables, and alerts directly to your draft content. This ensures issues and PRs have consistent formatting without manual edits.

What is GitHub-flavored Markdown and when do I need alert callouts?

GitHub-flavored Markdown is an extended syntax supporting tables, collapsible sections, and alert callouts. You need it when writing issues, PRs, or documentation on GitHub to ensure content renders correctly with proper semantic structure.

Can I copy formatted Markdown directly to the clipboard for GitHub PRs?

Yes, you can deliver formatted Markdown directly to the clipboard. The content is generated as copy-paste-ready text for GitHub issues, PRs, or comments, eliminating manual formatting and copy-paste mistakes.

What's the best way to generate structured tables for GitHub documentation?

Generating structured tables is best handled by applying GitHub-flavored Markdown formatting to your raw content. This enforces GitHub-compatible syntax and produces clean, ready-to-paste tables for documentation files.

Does this Markdown formatting approach support local file delivery?

Yes, this Markdown formatting approach supports local file delivery. You can choose to output the formatted GitHub-ready content to local files, the clipboard, or directly to GitHub based on your specific workflow.