skills.rest
woocommerce
woocommerceOFFICIAL
Explore all skills by this author →
Website𝕏@woocommerceGitHub

woocommerce-markdown

Lint WooCommerce Markdown files with markdownlint and enforce UTF-8 encoding.

10.5k|10.7k|Updated Aug 9, 2011
Search Tags:#automation#linting#documentation#markdown#formatting#content#woocommerce
One-click install
npx skills add https://github.com/woocommerce/woocommerce --skill woocommerce-markdown
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: woocommerce-markdown
Source: https://github.com/woocommerce/woocommerce/tree/main/.ai/skills/woocommerce-markdown
Command: npx skills add https://github.com/woocommerce/woocommerce --skill woocommerce-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires markdownlint-cli.

What problem does it solve?

This Skill standardizes markdown content creation in WooCommerce, eliminating inconsistencies and ensuring all documentation, READMEs, and AI-facing files are perfectly formatted and lint-free. It saves time by automating formatting corrections and providing clear guidelines.

Core Features & Use Cases

  • Automated Formatting: Provides clear rules and commands for auto-fixing common markdown issues, significantly reducing manual correction time.
  • Standardized Structure: Guides on proper heading hierarchy, list indentation, code block syntax, and table formatting, ensuring consistent and readable documentation.
  • AI-Optimized Content: Emphasizes rules for CLAUDE.md files, ensuring optimal parsing and understanding by AI assistants for enhanced productivity.
  • Use Case: A technical writer is updating a WooCommerce plugin's README.md and a new CLAUDE.md file. Instead of manually checking every formatting rule, they use this skill to quickly apply auto-fixes and verify compliance with all project-specific markdownlint rules, ensuring consistent, high-quality documentation.

Quick Start

Use the woocommerce-markdown skill to explain how to properly format code blocks in markdown files, including language specification.

Frequently Asked Questions about woocommerce-markdown

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

FAQPage Schema
How do I enforce consistent markdown formatting in WooCommerce documentation?▼

Markdown linting enforces consistent formatting across WooCommerce projects by running markdownlint with a configured rule set, validating UTF-8 encoding, enforcing 4-space indentation, requiring language-specified code blocks, and ensuring files end with a single newline. This eliminates inconsistencies in READMEs, docs, and AI-facing content.

What markdown rules should I follow for WooCommerce CLAUDE.md files?▼

WooCommerce CLAUDE.md files require AI-optimized markdown formatting with proper heading hierarchy, list indentation, language-specified code blocks, and table formatting. Following these linting rules ensures optimal parsing by AI assistants and enhanced productivity.

Can I automatically fix markdown formatting issues in my documentation?▼

Yes, markdownlint-cli provides auto-fix capabilities for common markdown issues, significantly reducing manual correction time. The WooCommerce markdown skill applies project-specific linting rules to automatically correct formatting violations across documentation files.

When do I need to lint markdown files in my WooCommerce project?▼

Linting is required when authoring or updating README files, docs, or any markdown content within the WooCommerce repository. It standardizes documentation structure, ensures compliance with encoding and formatting standards, and maintains consistency across all project documentation.

Does markdownlint-cli enforce code block language specification?▼

Yes, markdownlint-cli enforces language-specified code blocks as part of WooCommerce's markdown standards. This requirement ensures code readability, proper syntax highlighting, and compliance with documentation best practices across the project.

What encoding standard should my markdown files use?▼

WooCommerce markdown files must use UTF-8 encoding to ensure consistent character representation and compatibility across all systems and tools. This is automatically validated when applying the markdown linting skill to your documentation.

Related Skills

Explore More Content & Communication Skills→
mwathibenmwathiben

woocommerce-markdown

Lint WooCommerce Markdown files against configured markdownlint rules.

Community
Intermediate
leaderiopleaderiop
7

Documentation Docusaurus

Enforce Docusaurus coding standards across MDX/Markdown content, configuration, and navigation.

Community
Intermediate
Haohao-endHaohao-end
779

setup-pre-commit

Configure pre-commit hooks to run linting, formatting, and validation checks.

Community
Basic
bresendsbresends

lint-markdown

Lint and fix Markdown files using markdownlint-cli2.

Community
Intermediate