standards-markdown

Standardize Markdown formatting according to Google style guidelines.

2|Updated Apr 10, 2024
One-click install
npx skills add https://github.com/gdurandvadas/dotfiles --skill standards-markdown
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: standards-markdown
Source: https://github.com/gdurandvadas/dotfiles/tree/main/config/opencode/skills/standards-markdown
Command: npx skills add https://github.com/gdurandvadas/dotfiles --skill standards-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Markdown writing and reviews often miss style consistency, introducing variance and readability issues. This skill provides a clear set of Google-style guidelines, formatting checklists, and common pitfall guidance to improve documentation quality.

Core Features & Use Cases

  • Enforces consistent structure, headings, lists, and code formatting to improve readability.
  • Guides authors during documentation reviews, reducing review cycles and improving publish readiness.
  • Use case: you are updating a large Markdown guide and want to ensure style consistency across sections and tables.

Quick Start

Apply the Markdown standards to a sample document to improve consistency and readability.

Frequently Asked Questions about standards-markdown

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

FAQPage Schema
How do I make my Markdown documentation more consistent across a large project?

To make Markdown documentation consistent, apply standardized style guidelines to headings, lists, code blocks, and links. This enforces structural uniformity across project READMEs and developer guides, reducing readability issues and formatting variance.

What is the best way to enforce a Markdown style guide during documentation reviews?

The best way to enforce a Markdown style guide during reviews is using a checklist based on Google Markdown guidelines. This standardizes formatting for headings, lists, and code blocks, reducing review cycles and improving publish readiness.

How do I fix inconsistent heading and list formatting in my project READMEs?

Fix inconsistent heading and list formatting by applying Google Markdown style guidelines to your project READMEs. This standardizes document structure, enforces consistent code block formatting, and solves overall documentation readability issues.

Do I need any external dependencies to standardize Markdown writing for developer guides?

No external dependencies are required to standardize Markdown writing for developer guides. The skill provides a self-contained set of style guidelines and formatting checklists to review and polish documentation directly.

Can I use Google Markdown style guidelines to check code blocks and links in my docs?

Yes, you can use Google Markdown style guidelines to check code blocks and links. The standards specifically target these elements to ensure formatting consistency, solve variance issues, and improve overall documentation quality.

Why does inconsistent Markdown formatting cause readability issues in technical documentation?

Inconsistent Markdown formatting causes readability issues because varying heading structures, list styles, and code blocks introduce visual variance. Applying a consistent style guide solves these problems, ensuring documentation remains polished and uniform.