markdown-writing

Draft and revise Markdown content that follows markdownlint rules.

8|1|Updated Mar 9, 2019

Search Tags:#documentation #writing #markdown #readme #notes #guides #lint

Ready to run

npx skills add https://github.com/wangl-cc/dotfiles --skill markdown-writing-wangl-cc

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown-writing
Source: https://github.com/wangl-cc/dotfiles/tree/main/home/dot_agents/skills/markdown-writing
Command: npx skills add https://github.com/wangl-cc/dotfiles --skill markdown-writing-wangl-cc

SYSTEM DOCUMENTATION & REQUIREMENTS

## What problem does it solve?

Markdown writing is often verbose or inconsistent, making documentation harder to read and harder to lint. This Skill helps you craft concise, well-structured Markdown that passes common markdownlint checks.

## Core Features & Use Cases

Generate README files, guides, notes, and SKILL.md entries that follow a clean, scannable structure.
Revise existing Markdown to improve readability, consistency, and conformance to markdownlint rules.
Adapt content for different audiences while preserving logical flow and minimal noise.

### Quick Start

Please provide the topic and any key points, and I will draft a clear, markdownlint-friendly Markdown document.

Frequently Asked Questions about markdown-writing

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

FAQPage Schema

How do I write markdown that passes markdownlint checks?▼

Markdownlint-friendly markdown requires a single top-level heading, properly fenced code blocks with language tags, and blank lines around sections and lists to ensure clean structure and valid links.

What is the best way to structure a README file for readability?▼

The best way to structure a README file for readability is to use consistent headings, concise formatting, and a clean, scannable layout that preserves logical flow while minimizing noise for different audiences.

Can I revise existing markdown notes to fix linting errors?▼

Yes, you can revise existing markdown notes to fix linting errors by applying markdownlint-friendly rules, ensuring consistent headings, compliant list formatting, and clean structural flow throughout the document.

How do I format code blocks in markdown documentation?▼

To format code blocks in markdown documentation, use properly fenced code blocks with specified language tags, and surround them with blank lines to maintain markdownlint compliance and improve content scannability.

Does writing markdownlint-friendly guides require any special tools?▼

Writing markdownlint-friendly guides does not require special tools or dependencies; you only need to provide the topic and key points to draft clean, well-structured documentation with valid links and compliant formatting.