# Create WooCommerce Markdown That Passes Lint

Inconsistent Markdown creates lint failures and slows documentation reviews. This skill applies WooCommerce formatting rules and provides a repeatable validation workflow.

## Install

```bash
npx skillstore add woocommerce/woocommerce-markdown
```

## Metadata

- Status: approved
- Slug: woocommerce-woocommerce-markdown
- Skillstore revision: r2
- Version status: missing
- Tree hash: 615aa394c071cf56215b02d25de45fedbecb9d458708eb0038449243eb40a8a9
- Author: woocommerce
- GitHub username: woocommerce
- License: MIT
- Repository: https://github.com/woocommerce/woocommerce/tree/trunk/.ai/skills/woocommerce-markdown
- Ref: 88a8e9a07f4c54ab105c1c41b6267c287146b07b
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands, network, filesystem
- Quality score: 78
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/woocommerce-woocommerce-markdown
- Manifest: https://skillstore.pages.dev/api/skills/woocommerce-woocommerce-markdown/manifest

## Capabilities

- Applies WooCommerce heading, list, code block, and whitespace conventions.
- Formats links, tables, emphasis, and UTF-8 directory trees.
- Adds language identifiers and spacing around fenced code blocks.
- Explains common markdownlint failures and their corrections.
- Guides markdownlint auto-fix and verification from the repository root.
- Adapts structure for README, changelog, and CLAUDE.md files.

## Use Cases

- Prepare Contributor Documentation: Create or revise WooCommerce guides before review and lint validation.
- Standardize Repository Files: Align README and CLAUDE.md files with shared formatting conventions.
- Polish Release Notes: Format changelog entries with consistent headings, dates, and change groups.

## Prompt Templates

### Format a New Document

```
Create a WooCommerce README for [component] with installation, usage, and testing sections. Follow the repository Markdown rules.
```

### Fix Existing Markdown

```
Revise [file] to satisfy WooCommerce markdownlint conventions. Preserve meaning and summarize every formatting change.
```

### Audit Documentation Structure

```
Audit [document] for heading hierarchy, list indentation, code languages, links, tables, and spacing. Return prioritized corrections.
```

### Restructure AI Instructions

```
Reorganize [CLAUDE.md content] for reliable AI parsing. Preserve requirements, add navigation, and identify conflicting instructions.
```

## Limitations

- It does not install markdownlint or other repository dependencies.
- It cannot replace the repository configuration as the final authority.
- Automated fixes cannot resolve every structural or language-label issue.
- The control-character cleanup command can remove line breaks and requires a backup.

## Best Practices

- Run markdownlint from the repository root so the project configuration is loaded.
- Preserve the document meaning while making formatting corrections.
- Review auto-fixed content and verify a clean lint result before committing.

## Anti Patterns

- Do not skip heading levels or replace headings with emphasized text.
- Do not use unlabeled code fences or inconsistent list indentation.
- Do not overwrite a source file with cleanup output before reviewing a backup.

## Security Audit

- Audited at: 2026-07-24T02:04:07.156\+00:00
- Summary: Eighty-three alerts are false positives caused by Markdown fences, inline code, placeholder links, a relative link example, and a PHP method name. One medium-risk command is confirmed because the cleanup pipeline removes line breaks before replacing the original file.

## Stats

- Views: 310
- Downloads: 9
- Favorites: 0
- Popularity score: 0