mcpField
M
md-syntax

md-syntax

github.com/jimwellerDocuments69 installs
Repository

About md-syntax

md-syntax is a skill for authors editing Markdown files. It sets out formatting and structure rules, including fenced code language labels and a final newline.

Key features

  1. 01Language labels for code blocks
  2. 02Heading and document structure rules
  3. 03Spacing between Markdown styles
  4. 04Formatter contract and lint guidance
  5. 05Trailing newline requirement

Use cases

  1. 01Creating a new Markdown file
  2. 02Editing Markdown to follow formatting rules

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/jimweller/clanker-skills --skill md-syntax

After installing, type/md-syntaxin Claude Code to confirm it loaded.

Details

From the project README

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 # Title at 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-lint for 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.

Comments

Markdown supported