markdown-no-artificial-line-wraps

Remove artificial hard line breaks from Markdown prose paragraphs.

47.5k|2.5k|Updated Jun 20, 2019
One-click install
npx skills add https://github.com/prisma/prisma --skill markdown-no-artificial-line-wraps
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-no-artificial-line-wraps
Source: https://github.com/prisma/prisma/tree/main/skills-contrib/markdown-no-artificial-line-wraps
Command: npx skills add https://github.com/prisma/prisma --skill markdown-no-artificial-line-wraps

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents the creation of noisy git diffs and awkward text reflows caused by manual hard line breaks in Markdown source files.

Core Features & Use Cases

  • Prose Preservation: Ensures paragraphs remain as single lines to allow for natural viewport-based soft wrapping.
  • Semantic Formatting: Maintains explicit line breaks only where necessary, such as in lists, headings, and code blocks.
  • Use Case: When drafting documentation or ADRs, use this Skill to ensure that your edits remain clean and readable across different editors and GitHub's diff viewer.

Quick Start

Use the markdown-no-artificial-line-wraps skill to reformat the current document by joining all wrapped paragraph lines into single lines.

Frequently Asked Questions about markdown-no-artificial-line-wraps

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

FAQPage Schema
Why do my markdown documentation diffs show changed lines when I only edited a few words?

Manual hard line breaks in markdown prose cause git diffs to highlight entire paragraphs as changed. Removing these artificial line wraps ensures that edits only display the modified text, keeping your documentation diffs clean and readable.

How do I remove manual line breaks in markdown paragraphs without breaking lists and code blocks?

To remove manual line breaks in markdown, join wrapped paragraph lines into single lines while preserving the semantic formatting of lists, headings, and code blocks. This maintains explicit breaks only where structurally necessary for rendering.

What is the best way to format markdown prose for consistent rendering across different editors?

The best way to format markdown prose for consistent rendering is to maintain single-line paragraph structures. This allows editors to apply natural viewport-based soft wrapping instead of relying on manual hard line breaks that disrupt text reflow.

Does removing artificial line wraps in markdown affect GitHub's diff viewer?

Removing artificial line wraps improves GitHub's diff viewer by preventing noisy, paragraph-wide highlights. Your markdown edits remain clean and readable because the diff viewer only highlights the actual modified text within the unwrapped prose.

When should I keep explicit line breaks in markdown source files?

You should keep explicit line breaks in markdown source files only for semantic formatting elements like lists, headings, and code blocks. Prose paragraphs should have their artificial hard line breaks removed to maintain single-line structures.

Can I use this markdown formatting approach for technical specifications and ADRs?

Yes, you can use this markdown formatting approach for technical specifications and ADRs. Standardizing the source formatting prevents awkward text reflows and noisy git diffs, ensuring your architectural documentation remains clean across different editors.