From common
Markdown formatting conventions covering heading hierarchy, code blocks, tables, lists, links, images, and accessibility best practices. Apply this skill whenever writing or editing .md files -- including READMEs, documentation pages, changelogs, or any markdown content -- even if the user does not explicitly mention "markdown formatting." Also apply when reviewing markdown for consistency, readability, or accessibility concerns such as missing alt text or non-descriptive link text.
npx claudepluginhub atc-net/atc-agentic-toolkit --plugin commonThis skill uses the workspace's default tool permissions.
Apply these conventions when writing, editing, or reviewing markdown files to ensure consistent, readable, and accessible content.
Master Markdown, GitHub Flavored Markdown, READMEs, and doc formatting with syntax guides, references for lists/links/diagrams, and best practices.
Provides reference for core Markdown syntax: headings, text formatting, lists, links, images, code blocks, blockquotes. Use when writing or editing Markdown files.
Guides markdown linting with markdownlint-cli2: run checks, fix MD0XX errors, configure .markdownlint-cli2.jsonc rules/ignores, set up VS Code extension and GitHub Actions. Supports GFM/CommonMark for validation and workflows.
Share bugs, ideas, or general feedback.
Apply these conventions when writing, editing, or reviewing markdown files to ensure consistent, readable, and accessible content.
Use H2 (##) and H3 (###) for document structure. H1 is reserved for the document title (typically generated automatically from metadata or filename) -- never add an H1 inside the body.
If you find yourself reaching for H4 (####) or deeper, that is a signal the document structure is too nested. Restructure by splitting into separate sections or files instead.
## Main Section
Content here.
### Subsection
More detail here.
Use - for unordered (bullet) lists and 1. for ordered (numbered) lists. Indent nested items with 2 spaces:
- First item
- Nested item
- Another nested item
- Second item
1. Step one
2. Step two
1. Sub-step
Keep list items parallel in grammatical structure -- if one item starts with a verb, they all should.
Use fenced code blocks (triple backticks) with a language identifier for syntax highlighting. This helps both readers and tooling parse the content correctly:
```csharp
var result = await service.GetDataAsync(cancellationToken);
```
Use inline code (single backticks) for short references to code elements within prose, such as method names, variable names, or file paths.
Use descriptive link text that makes sense out of context -- screen readers often navigate by links alone, so "click here" or "this page" convey no meaning:
<!-- Good -->
See the [contributing guidelines](CONTRIBUTING.md) for details.
<!-- Avoid -->
Click [here](CONTRIBUTING.md) for details.
Ensure all URLs are valid and point to the intended target.
Always include alt text that describes the image content for accessibility. The alt text should convey what the image shows, not just repeat the filename:
Use markdown tables with pipe (|) syntax. Include a header row and alignment indicators:
| Name | Type | Description |
|------------|----------|----------------------|
| id | integer | Unique identifier |
| status | string | Current state |
Keep columns aligned in the source for readability. For data that would create very wide tables, consider restructuring as a definition list or separate subsections instead.