Markdown Formatting Skill

Format documentation into Markdown and C# XML doc comments.

Updated Nov 13, 2025
One-click install
npx skills add https://github.com/changjian-wang/dawning --skill markdown-formatting-skill
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Markdown Formatting Skill
Source: https://github.com/changjian-wang/dawning/tree/main/.github/skills/markdown
Command: npx skills add https://github.com/changjian-wang/dawning --skill markdown-formatting-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures your documentation is consistently formatted, easy to read, and adheres to best practices for both Markdown and C# XML documentation.

Core Features & Use Cases

  • Markdown Formatting: Applies 10 core rules for clean, readable Markdown.
  • XML Documentation: Generates standard C# XML doc comments for code.
  • Bilingual Docs: Helps maintain consistency between English and Chinese documentation.
  • Use Case: Ensure all your project's README files, API documentation, and code comments are perfectly formatted and bilingual.

Quick Start

Use the markdown skill to format the following text as clean Markdown.

Frequently Asked Questions about Markdown Formatting Skill

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

FAQPage Schema
How do I format Markdown documentation to be clean and consistent?

To format Markdown documentation cleanly, this Skill applies 10 core formatting rules that standardize structure and readability. It processes raw text and outputs standardized Markdown for README files and API docs.

How do I generate C# XML doc comments from code?

Generating C# XML documentation is supported by providing standard XML doc comment examples. It formats code comments into standard C# XML documentation structures for API reference generation.

What is the best way to maintain bilingual documentation in English and Chinese?

Maintaining bilingual documentation is handled by enforcing formatting consistency across English and Chinese languages. It standardizes both translations within your Markdown files to ensure structural parity.

When do I need standard XML documentation for C# projects?

Standard XML documentation is needed for C# projects when generating API reference docs or maintaining consistent code comments. It provides structured metadata for public classes and methods.

Can I use this to format both README files and code comments?

Formatting both README files and code comments is supported by processing Markdown and C# XML doc comments. It ensures project documentation and inline code comments share consistent formatting standards.