poocommerce-markdown

Guide Markdown creation and editing with PooCommerce linting standards.

2|Updated Nov 8, 2024
One-click install
npx skills add https://github.com/notmattpress/poocommerce --skill poocommerce-markdown
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: poocommerce-markdown
Source: https://github.com/notmattpress/poocommerce/tree/main/.ai/skills/woocommerce-markdown
Command: npx skills add https://github.com/notmattpress/poocommerce --skill poocommerce-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires markdownlint-cli.

What problem does it solve?

Inconsistent Markdown formatting can lead to unreadable documentation and wasted time in manual corrections. This Skill provides a definitive guide to PooCommerce's Markdown standards, ensuring all documentation is clear, consistent, and passes automated linting checks.

Core Features & Use Cases

  • Automated Formatting Guidance: Detailed rules for headings, lists, code blocks, links, and tables, aligned with markdownlint configuration.
  • Critical Rule Enforcement: Emphasizes running markdownlint --fix from the repository root and using UTF-8 encoding for directory trees.
  • Common Error Resolution: Provides clear examples and fixes for frequent Markdown linting issues like indentation, blank lines, and missing language specs.
  • Use Case: When writing or updating any documentation, use this Skill to quickly format your Markdown content, automatically fix common errors, and ensure it's perfectly aligned with project standards for optimal readability and AI parsing.

Quick Start

Use the poocommerce-markdown skill to explain how to correctly format a code block with a language spec and blank lines around it.

Frequently Asked Questions about poocommerce-markdown

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

FAQPage Schema
How do I ensure my PooCommerce markdown documentation passes linting checks?

Run `markdownlint --fix` from the repository root to automatically correct formatting issues, then run `markdownlint` to verify compliance. This enforces ATX heading style, 4-space list indentation, language-specified code blocks, blank lines around blocks, UTF-8 encoding, and trailing newlines across all markdown files.

What are the markdown formatting standards for PooCommerce documentation?

PooCommerce markdown requires ATX heading style, 4-space indentation for lists, language-specified code blocks with blank lines before and after, UTF-8 encoding, and a trailing newline at the end of files. These standards apply to all documentation, README files, and in-code markdown content.

How do I format code blocks correctly in PooCommerce markdown?

Wrap code blocks with triple backticks and specify the language (e.g., ```javascript), add blank lines before and after the block, and ensure proper indentation. Language specification helps both readability and AI parsing of documentation.

Can I use markdownlint to automatically fix formatting errors in my documentation?

Yes. The `markdownlint --fix` command automatically corrects common markdown formatting issues like indentation, missing blank lines, and heading style. Run it from your repository root to apply fixes across all markdown files before manual review.

What file encoding should I use for PooCommerce markdown files?

Use UTF-8 encoding for all markdown files in PooCommerce documentation. This ensures consistent character handling across the repository and proper rendering in all environments and tools.

When should I run markdown linting in my PooCommerce documentation workflow?

Run `markdownlint --fix` after writing or updating any markdown content, then run `markdownlint` to verify compliance before committing. This catches formatting inconsistencies early and maintains documentation quality standards across the project.