Agent skill

WooCommerce Markdown Guidelines

by woocommerce in woocommerce/woocommerce

Rules for writing and editing markdown in the WooCommerce repository, with the project's markdownlint settings for headings, lists and code blocks.

Custom licenceAuto-check passedDevelopment

Install WooCommerce Markdown Guidelines

skills CLI
$ npx skills add woocommerce/woocommerce --skill woocommerce-markdown -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install woocommerce/woocommerce woocommerce-markdown --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/woocommerce/woocommerce.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.ai/skills/woocommerce-markdown .claude/skills/woocommerce-markdown && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
woocommerce-markdown
GitHub stars
11k
Used in
1 other repo
Token cost
~1.7k tokens
SKILL.md length
572 words
Files
1
Skills in repo
11
Repo updated
First seen
Licence
Custom licence

At a glance

Rules for writing and editing markdown in the WooCommerce repository, with the project's markdownlint settings for headings, lists and code blocks.

  • Works in 4 steps: Always lint after changes - Run… → Run from repository root - Ensures… → Use UTF-8 encoding - Especially for… → …
  • Writing or updating a README or docs page in the WooCommerce repo
  • SKILL.md covers Critical Rules, WooCommerce Markdown…, Markdown Writing Guidelines and Workflow for Editing Markdown, plus 4 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

The skill tells the agent how to write documentation, README files and other markdown for the WooCommerce project. The main rule is to lint after every change: run `markdownlint --fix` and then `markdownlint` from the repository root so the `.markdownlint.json` configuration is picked up, and save files as UTF-8, especially when they contain directory trees or special characters.

It spells out the enabled rules: ATX-style headings, four-space indentation for nested lists, no line length limit, duplicate headings allowed among siblings, blank lines around fenced code blocks and lists, a short list of permitted HTML elements, no bold text standing in for headings, a language tag on every fenced block, and a single trailing newline. Tabs and trailing whitespace are permitted. The style notes add one H1 per file, no skipped heading levels, hyphens for bullets, and common language identifiers such as bash, php, javascript and json.

When your agent uses it

  • Writing or updating a README or docs page in the WooCommerce repo
  • Fixing markdownlint errors in a markdown file
  • Formatting code blocks, lists and headings to the project's style

Example prompts

  • “Write a README for the new shipping module and make sure it passes markdownlint.”
  • “Fix the markdownlint errors in docs/contributing.md.”
  • “Add a setup section with a bash code block to the testing guide, following the WooCommerce markdown rules.”

Requirements

  • markdownlint
  • A WooCommerce checkout with its `.markdownlint.json` file

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Always lint after changes - Run markdownlint --fix then markdownlint to verify
  2. Run from repository root - Ensures .markdownlint.json config is loaded
  3. Use UTF-8 encoding - Especially for directory trees and special characters
  4. Follow WooCommerce markdown standards - See configuration rules below

What it can do on your machine

Read from SKILL.md and the folder at commit 3bb7a91. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown and bash).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

WooCommerce Markdown Guidelines loads about 1.7k tokens when it runs. Until then it costs about 40 tokens; SKILL.md has 572 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~40
When it runs · the whole SKILL.md, loaded when a task matches
~1.7k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 572 words (~1,693 tokens).

“This skill provides guidance for creating and editing markdown files in the WooCommerce project.”

— opening of SKILL.md by woocommerce, Custom licence
name
woocommerce-markdown

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .ai/skills/woocommerce-markdown of woocommerce/woocommerce.

Open the folder on GitHubat commit 3bb7a91

Used in 1 other repository

We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in woocommerce/woocommerce, which our catalogue first saw on October 7, 2026.

Compare with similar skills

WooCommerce Markdown Guidelines next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

WooCommerce Markdown Guidelines compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
WooCommerce Markdown Guidelines this skillwoocommerce/woocommerce11k1 repos~1.7kAutomated safety check: PassCustom licence
Docs Conventionsflet-dev/flet17k—~1.6kAutomated safety check: PassApache-2.0
Flowmark Markdown Formatterjlevy/repren374—~631Automated safety check: PassMIT
Lint Repository Markdowncodsen/codsen214—~832Automated safety check: PassMIT
Article Formatterflawlessv/Spring-Broken-AI-Blog102—~241Automated safety check: PassNone
Article Exporteractionbook/actionbook1.6k—~3.1kAutomated safety check: PassApache-2.0

Similar skills

  • Docs Conventions

    flet-dev/flet

    A skill your agent uses when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples)…

    17k GitHub stars~1.6k tokensUpdated today
    DevelopmentAuto-check passed
  • Formats Markdown with the Flowmark auto-formatter for typographic cleanup and semantic line breaks, and helps adopt it across a repository.

    374 GitHub stars~631 tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Keep the repository's linted Markdown passing npm run lint:markdown.

    214 GitHub stars~832 tokensUpdated 9 days ago
    DevelopmentAuto-check passed
  • Article Formatter

    flawlessv/Spring-Broken-AI-Blog

    为指定的 Markdown 文章添加完整的 frontmatter 头信息,包括 title、slug、category、readingTime 等字段。当用户需要格式化文章、添加文章头信息时使用此 Skill。

    102 GitHub stars~241 tokensUpdated 7 mo ago
    DevelopmentAuto-check passed
  • Article Exporter

    actionbook/actionbook

    Export any web article to a local Obsidian-ready Markdown directory.

    1.6k GitHub stars~3.1k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Headless Mode

    live-codes/livecodes

    Run playground without visible UI using SDK methods directly.

    1.5k GitHub stars~1.1k tokensUpdated yesterday
    DevelopmentAuto-check passed

More from woocommerce/woocommerce

All 11 skills in this repo
  • WooCommerce Code Review

    woocommerce/woocommerce

    Reviews WooCommerce code changes against the project's standards, flagging backend PHP architecture, naming, documentation, data integrity and testing violations.

    11k GitHub starsUsed in 3 repos~1.1k tokens
    Auto-check passed
  • Sets up a local environment for the WooCommerce block email editor, with a watcher, Mailpit email capture and build and test commands for its PHP and JS packages.

    11k GitHub stars~893 tokensUpdated today
    Auto-check passed
  • WooCommerce Dev Cycle

    woocommerce/woocommerce

    Workflow for WooCommerce development: run PHP and JavaScript tests, lint and fix code style on the current branch, and follow guides for i18n and markdown.

    11k GitHub starsUsed in 3 repos~431 tokens
    Auto-check passed
  • WooCommerce Git Commit

    woocommerce/woocommerce

    Commits pending changes with short, verb-first messages that follow WooCommerce repository conventions, splitting commits only when changes are clearly unrelated.

    11k GitHub stars~1.2k tokensUpdated today
    Auto-check passed
  • WooCommerce Draft PR Creator

    woocommerce/woocommerce

    Opens a concise draft pull request for the current branch, working out change type, base branch, title and body from the commits and diff.

    11k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Starts, stops, restarts, and troubleshoots the WooCommerce Core wp-env setup and its asset build watchers without re-reading the setup docs.

    11k GitHub stars~1.1k tokensUpdated today
    Auto-check passed

Works with

Questions about WooCommerce Markdown Guidelines

What does WooCommerce Markdown Guidelines do?

Rules for writing and editing markdown in the WooCommerce repository, with the project's markdownlint settings for headings, lists and code blocks. The skill tells the agent how to write documentation, README files and other markdown for the WooCommerce project.json` configuration is picked up, and save files as UTF-8, especially when they contain directory trees or special characters.

When should I use WooCommerce Markdown Guidelines?

WooCommerce Markdown Guidelines fits situations like: writing or updating a README or docs page in the WooCommerce repo; fixing markdownlint errors in a markdown file; formatting code blocks, lists and headings to the project's style.

How do I install WooCommerce Markdown Guidelines in Claude Code?

Run `npx skills add woocommerce/woocommerce --skill woocommerce-markdown -a claude-code`. Or copy the skill folder (.ai/skills/woocommerce-markdown in woocommerce/woocommerce) into .claude/skills/woocommerce-markdown in your project. Claude Code loads it when a task matches its description.

How do I install WooCommerce Markdown Guidelines in Codex?

Run `npx skills add woocommerce/woocommerce --skill woocommerce-markdown -a codex`. Or copy the skill folder (.ai/skills/woocommerce-markdown in woocommerce/woocommerce) into .agents/skills/woocommerce-markdown in your project. Codex loads it when a task matches its description.

Can I use WooCommerce Markdown Guidelines in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add woocommerce/woocommerce --skill woocommerce-markdown -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/woocommerce-markdown, .gemini/skills/woocommerce-markdown, .github/skills/woocommerce-markdown and .opencode/skills/woocommerce-markdown in your project.

What does WooCommerce Markdown Guidelines need to run?

SKILL.md names no scripts, command-line tools or credentials: WooCommerce Markdown Guidelines is instructions for the agent only. Our summary lists: markdownlint; A WooCommerce checkout with its `.markdownlint.json` file.

Does WooCommerce Markdown Guidelines access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is WooCommerce Markdown Guidelines safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does WooCommerce Markdown Guidelines use?

WooCommerce Markdown Guidelines has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does WooCommerce Markdown Guidelines use?

About 1.7k tokens (SKILL.md is roughly 6.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to WooCommerce Markdown Guidelines?

Skills that share tags, products or a category with WooCommerce Markdown Guidelines: Docs Conventions (flet-dev/flet, 17k stars), Flowmark Markdown Formatter (jlevy/repren, 374 stars), Lint Repository Markdown (codsen/codsen, 214 stars) and Article Formatter (flawlessv/Spring-Broken-AI-Blog, 102 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains WooCommerce Markdown Guidelines?

woocommerce (a GitHub organization) maintains it in woocommerce/woocommerce, which has 10,542 GitHub stars. The repository holds 11 skills in this directory. The repository was last updated on October 9, 2026.

Source: woocommerce/woocommerce on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.