md-syntax
Markdown authoring guidelines for formatting, code blocks, and structure. Use when writing or editing markdown files.
How do I install this agent skill?
npx skills add https://github.com/jimweller/clanker-skills --skill md-syntaxIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill contains benign markdown formatting and authoring guidelines for an AI agent. It does not include any executable code, network operations, or security-sensitive instructions.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
Markdown Authoring Guidelines
Follow these rules when creating or editing markdown files.
Rules
- Always specify language on code blocks - Use
bash,yaml,json,text,hcl,go, etc. Never use bare``` - No AI slop - Never use emojis, glyphs or emdashes
- Use headings, not bold for section titles - Use proper heading levels (
##,###, etc.) not**Bold**on its own line - One H1 per file - Only one
# Titleat the top - First line should be H1 - Start files with
# Title - Write to the formatter contract - A PostToolUse hook reformats markdown after every write. See
/md-lintfor what it rewrites and which lint rules it cannot fix - Blank lines between styles - Put single blank line between different markdown types
Examples
Blank lines between styles
Put a single blank line between markdown types/styles. Do not put multiple blank lines between markdown styles.
CORRECT
## Heading
paragraph
- list item one
- list item two
> block quote
INCORRECT
## Heading
paragraph
- list item one
- list item two
> block quote
Headings not bold
CORRECT
### Heading
paragraph
INCORRECT
**heading incorrect bold**
paragraph
Code Blocks
Always specify language.
CORRECT with language
```bash
#!/bin/bash
```
INCORRECT without language
```
#!/bin/bash
```
Trailing New Line
End the file with a single newline after the last line of content. A fenced example can't show this, because the fence hides the final byte. Check it with tail -c 1 file.md | xxd, which must print 0a.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/jimweller/clanker-skills/md-syntax">View md-syntax on skillZs</a>