# Format Markdown for Clearer Reading

Turn plain text or uneven Markdown into a structured document that readers can scan quickly. Preserve the author's content while improving headings, emphasis, lists, frontmatter, and typography.

## Install

```bash
npx skillstore add jimliu/baoyu-format-markdown
```

## Metadata

- Status: approved
- Slug: jimliu-baoyu-format-markdown
- Version: 1.57.0
- Author version: 1.57.0
- Skillstore revision: r2
- Version status: valid
- Tree hash: 39f53a98b32d7afebb8901f5f4ffb8b29b3a966bfc809199f3ac63e5cf056c2d
- Author: jimliu
- GitHub username: jimliu
- License: MIT
- Repository: https://github.com/jimliu/baoyu-skills/tree/main/skills/baoyu-format-markdown/
- Ref: 1c2ebded2116f8124f45dba86a2e567f56e64d8e
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands, filesystem, network
- Quality score: 83
- Quality tier: gold
- Public page: https://skillstore.pages.dev/skills/jimliu-baoyu-format-markdown
- Manifest: https://skillstore.pages.dev/api/skills/jimliu-baoyu-format-markdown/manifest

## Capabilities

- Classify input as plain text or Markdown using visible structure.
- Create or update frontmatter with titles, slugs, summaries, descriptions, and cover image paths.
- Improve headings, emphasis, lists, tables, blockquotes, and code markers for readability.
- Write a formatted copy with a -formatted.md suffix or update the original for typography-only work.
- Apply CJK and English spacing, emphasis fixes, optional quote replacement, and frontmatter formatting.

## Use Cases

- Polish Draft Articles: Improve the structure and scanability of a plain-text or Markdown article without changing its substantive writing.
- Standardize Technical Notes: Add consistent headings, code markers, lists, and frontmatter to engineering notes before sharing them.
- Fix CJK Typography: Apply CJK and English spacing, emphasis, and optional quote fixes to an existing Markdown document.

## Prompt Templates

### Format a Draft

```
Format this draft as readable Markdown. Preserve every substantive sentence, add a clear title and summary, and save a formatted copy.
```

### Improve Existing Markdown

```
Optimize the Markdown structure of this file. Keep the existing meaning, improve heading hierarchy, emphasize key points, and convert clear parallel items into lists.
```

### Prepare Technical Documentation

```
Format this technical document for publication. Add accurate frontmatter, mark commands and file paths as code, organize procedures into lists, and preserve all technical details.
```

### Apply Controlled Typography Fixes

```
Run typography fixes on this Markdown file with spacing and emphasis enabled. Replace quotes only if requested, and report whether the original file or a copy was changed.
```

## Limitations

- It does not add, remove, shorten, or rewrite the author's substantive content.
- It relies on the host runtime and the autocorrect-node package for spacing fixes.
- It does not verify factual accuracy, links, citations, or Markdown meaning.
- It may change the target file when typography-only mode is selected.

## Best Practices

- Provide the exact input path and state whether the original may be changed.
- Use optimize mode when structure needs improvement, then review the formatted copy.
- Keep quote replacement disabled unless fullwidth quotation marks are required.

## Anti Patterns

- Do not use the formatter to rewrite claims, add research, or remove inconvenient content.
- Do not run typography-only mode on an original file without a backup or version control.
- Do not treat formatting changes as factual, accessibility, or link validation.

## Security Audit

- Audited at: 2026-08-07T10:40:56.056\+00:00
- Summary: The audit found one confirmed high-risk behavior: the formatter launches npx to execute autocorrect-node, which introduces external package and host-command risk. The remaining findings are false positives caused by documentation syntax, expected file formatting operations, dependency metadata, integrity hashes, or fixed text escapes; no prompt injection or data-exfiltration intent was found.

## Stats

- Views: 298
- Downloads: 13
- Favorites: 0
- Popularity score: 0