markdown-writing

Enforce sentence-per-line and paragraph spacing rules in markdown files.

3|1|Updated Mar 2, 2026
One-click install
npx skills add https://github.com/denniscalazans/denniscalazans-plugins --skill markdown-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-writing
Source: https://github.com/denniscalazans/denniscalazans-plugins/tree/main/plugins/dc/skills/writing
Command: npx skills add https://github.com/denniscalazans/denniscalazans-plugins --skill markdown-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you write and edit Markdown content more effectively, ensuring clarity, scannability, and adherence to best practices for various documentation and communication needs.

Core Features & Use Cases

  • Structural Formatting: Guides the use of headings, bold text, lists, and tables to organize information logically.
  • Sentence & Paragraph Structure: Enforces rules like one sentence per line, proper paragraph spacing, and trailing spaces for optimal rendering.
  • Use Case: When writing a README file for a new project, use this Skill to ensure the content is well-structured, easy to read, and effectively communicates the project's purpose and usage.

Quick Start

Use the markdown writing skill to format this draft PR description.

Frequently Asked Questions about markdown-writing

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

FAQPage Schema
How do I format markdown for clear and scannable documentation?

To format markdown for clear documentation, apply structural conventions like sentence-per-line, paragraph grouping, and specific spacing rules to optimize reader comprehension across files and PR descriptions.

What is the sentence-per-line rule in markdown writing?

The sentence-per-line markdown writing rule requires placing each individual sentence on its own line, which improves source readability and simplifies version control diffs when editing content.

Can I use markdown writing conventions for code comments and PR descriptions?

Yes, markdown writing conventions apply directly to code comments and PR descriptions, enforcing structured formatting and spacing rules to ensure technical communication remains scannable.

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

The best way to structure a README for scannability is using headings, bold text, lists, and tables to organize information logically while enforcing proper paragraph spacing.

Why does my markdown documentation render poorly despite correct syntax?

Markdown documentation renders poorly when missing specific spacing rules and trailing spaces, requiring strict adherence to paragraph grouping and sentence-per-line conventions for optimal rendering.