baoyu-format-markdown

Formats plain text or Markdown files with frontmatter, headings, and code blocks, preserving original content.

Updated May 18, 2018
One-click install
npx skills add https://github.com/812lcl/dotfiles --skill baoyu-format-markdown-812lcl
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: baoyu-format-markdown
Source: https://github.com/812lcl/dotfiles/tree/main/.agents/skills/baoyu-format-markdown
Command: npx skills add https://github.com/812lcl/dotfiles --skill baoyu-format-markdown-812lcl

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires unified, remark-parse, remark-cjk-friendly, remark-gfm, remark-frontmatter, remark-stringify, unist-util-visit, yaml, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Formats plain text or markdown content by applying frontmatter, improving headings, summaries, bold, lists, and code blocks, while preserving original content.

Core Features & Use Cases

  • Applies consistent frontmatter and structure to Markdown/docs
  • Improves readability with standardized headings, summaries, and emphasis
  • Outputs to {filename}-formatted.md for downstream use

Quick Start

Run the skill on a target Markdown file to generate a formatted version named {filename}-formatted.md.

Frequently Asked Questions about baoyu-format-markdown

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically format markdown files with frontmatter and structured headings?

To format markdown with frontmatter, this skill applies structured headings, bold, lists, and code blocks while preserving original content. It generates a clean, readable version named {filename}-formatted.md for downstream use.

What is the best way to add YAML frontmatter to plain text drafts?

Adding YAML frontmatter to plain text drafts is handled by applying consistent structure and typography tweaks driven by the SKILL.md configuration. This process turns unstructured notes into clean markdown without altering the original text.

Does remark formatting support GitHub Flavored Markdown and CJK characters?

Yes, remark formatting supports GitHub Flavored Markdown and CJK characters through dependencies like remark-gfm and remark-cjk-friendly. These libraries ensure lists, code blocks, and international text are parsed and stringified correctly.

Can I preserve original content while improving markdown readability?

You can preserve original content while improving markdown readability by running this skill, which standardizes headings, summaries, and emphasis. It outputs a new formatted file, ensuring your source text remains untouched and safe.

How do I configure markdown formatting rules for headings and code blocks?

You configure markdown formatting rules for headings and code blocks by editing the SKILL.md file and applying optional typography tweaks in the scripts directory. These settings drive how the unified and remark-parse libraries process your text.