woocommerce-markdown
Guidelines for creating and modifying markdown files in WooCommerce. Use when writing documentation, README files, or any markdown content.
Security Assessment
About woocommerce-markdown
The woocommerce-markdown skill provides essential guidelines for creating and modifying markdown files specifically for the WooCommerce project. It addresses the common challenges faced by developers and writers in maintaining consistency and quality in markdown documentation. By adhering to these guidelines, users can ensure that their markdown content is well-structured, easily readable, and compliant with WooCommerce standards, ultimately improving the overall documentation quality across the project.
This skill encompasses a comprehensive set of rules and configuration settings for using markdownlint, covering everything from heading styles to code block specifications. It emphasizes the importance of linting files after changes, using UTF-8 encoding, and following specific markdown formatting rules. Key features include detailed instructions on headings, lists, code blocks, inline code, links, tables, directory trees, and emphasis formatting. By following these guidelines, users can produce high-quality documentation that aligns with the expectations of the WooCommerce community.
Target users include developers, technical writers, and contributors to the WooCommerce project who need to create or update markdown files. Use cases range from writing README files and documentation to contributing to project discussions through markdown-formatted content. This skill is designed to streamline the writing process and ensure that all markdown files meet established standards, making collaboration within the WooCommerce ecosystem more efficient and effective.
FAQ
What should I do after making changes to a markdown file?
Always lint the file by running `markdownlint --fix` followed by `markdownlint` to verify your changes.
Is this skill compatible with other markdown tools?
This skill specifically uses markdownlint; compatibility with other tools may vary.
What are the requirements for using this skill?
You need to run commands from the repository root and ensure that UTF-8 encoding is used.
Can I use other heading styles besides ATX?
No, only ATX style headings are allowed as per WooCommerce markdown standards.
Are there any restrictions on list formatting?
Yes, unordered lists must use 4 spaces for indentation and should be surrounded by blank lines.
Install woocommerce-markdown
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
woocommerce/woocommerce