markdown-conventions

Enforce project-specific Markdown rules and YAML frontmatter schema during writing.

143|52|Updated May 15, 2026
One-click install
npx skills add https://github.com/gotgenes/pi-packages --skill markdown-conventions-gotgenes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-conventions
Source: https://github.com/gotgenes/pi-packages/tree/main/.pi/skills/markdown-conventions
Command: npx skills add https://github.com/gotgenes/pi-packages --skill markdown-conventions-gotgenes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Project-specific Markdown rules (one-sentence-per-line, compact tables, sequential numbering) and YAML frontmatter schema for plans/retros. Load when writing or editing Markdown — contains rules that differ from standard markdownlint defaults.

Core Features & Use Cases

  • Enforces one sentence per line for prose to improve diffs.
  • Enforces compact Markdown tables without extra spaces.
  • Enforces sequential numbering in ordered lists to maintain consistency.
  • Specifies guidelines for fenced code blocks and frontmatter usage.

Quick Start

Apply these Markdown conventions to the current document to ensure compliant formatting.

Frequently Asked Questions about markdown-conventions

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

FAQPage Schema
How do I enforce one-sentence-per-line formatting in Markdown documentation?

To enforce one-sentence-per-line formatting in Markdown documentation, apply project-specific markdown rules during writing and editing workflows. This standardizes prose style across documents and improves version control diffs by isolating changes to individual sentences.

What are the best Markdown conventions for improving git diffs in documentation?

The best Markdown conventions for improving git diffs include writing one sentence per line, using compact tables without extra spaces, and applying sequential numbering in ordered lists. These rules standardize document style and isolate textual changes for cleaner version control histories.

How do I set up a YAML frontmatter schema for Markdown plans and retrospectives?

To set up a YAML frontmatter schema for Markdown plans and retrospectives, apply project-specific markdown rules that define required metadata fields. This enforces structural consistency across planning documents and standardizes retrospective formatting.

Does this Markdown linting approach work without external dependencies?

Yes, this Markdown linting approach works without external dependencies. It provides project-specific rules that differ from standard markdownlint defaults and can be loaded directly during writing and editing workflows to enforce formatting conventions.

When do I need custom Markdown rules instead of standard markdownlint defaults?

You need custom Markdown rules instead of standard markdownlint defaults when your project requires specific conventions like one-sentence-per-line prose, compact tables without extra spaces, sequential numbering, and language-tagged fenced code blocks for documentation quality.