Back to Skills

convert-plaintext-to-md

Convert a text-based document to markdown following instructions from prompt, or if a documented option is passed, follow the instructions for that option.

30,587stars3,654forksUpdated 4/21/2026

Security Assessment

Safe(96/100)
Security Score96/100

About convert-plaintext-to-md

This skill turns a GitHub Copilot agent into a technical documentation specialist that converts plain-text or generically formatted documentation files into properly structured Markdown. It solves the common problem of legacy or exported documentation arriving as raw text with inconsistent headings, indentation, and formatting, giving the agent a repeatable process for producing clean, platform-appropriate Markdown.

The skill supports three conversion approaches: following explicit instructions in the prompt, applying documented options, or using an already-converted Markdown file as a reference template so new files match an established style. It is driven by a command syntax that accepts a target file plus optional parameters and flags, including a `finalize` pass to trim whitespace and sloppy formatting, a `guide` reference file, target-platform selection (GitHub-flavored Markdown, StackOverflow, VS Code, GitLab, or CommonMark), header-level options, pattern-matching with stop points, and predefined transforms such as removing leading digits from headers, shifting heading levels, and reducing indentation. When a `.md` file does not already exist it copies the source file first, then applies Markdown best practices.

It is aimed at technical writers, open-source maintainers, and developers who need to migrate or normalize documentation at scale while keeping formatting consistent across a project. Typical uses include converting exported release notes, README drafts, or command references into publish-ready Markdown for a specific rendering platform.

FAQ

What input does it need to run?

A text-based documentation file passed as the target. If a matching .md file already exists it is treated as the source data; otherwise the skill copies the original file to a .md file before converting.

Can I keep formatting consistent across multiple files?

Yes. Pass a previously converted Markdown file with the guide option and the skill will reuse its formatting patterns, structure, and conventions while adapting to the new file's content.

Which Markdown flavors are supported?

You can target GitHub-flavored Markdown (the default), StackOverflow, VS Code preview, GitLab, or standard CommonMark via the platform parameter.

What do the predefined transforms do?

They cover common cleanups: removing leading numbers from headers, changing a heading from one level to another, and reducing paragraph indentation. If a predefined name does not match, it is ignored.

Does it fetch anything from the internet?

Only optionally. If parameters or options are unclear it may use a fetch tool to retrieve reference URLs, but the core conversion works on local files.

Install convert-plaintext-to-md

Download and extract the skill files to your .claude/skills/ directory.

Quick Setup:

  1. Copy the skill folder to .claude/skills/
  2. Claude will automatically detect and use the skill