Convert Plaintext To Md
Turn legacy plain-text or generic text docs into consistent markdown using explicit rules, a documented option, or a reference converted file as the style guide.
Overview
Convert Plaintext to Markdown is an agent skill for the Build phase that converts text-based documents to markdown following prompt instructions, a documented option, or a reference file’s patterns.
Install
npx skills add https://github.com/github/awesome-copilot --skill convert-plaintext-to-mdWhat is this skill?
- Three conversion modes: explicit instructions, documented procedure options, or reference markdown template
- Applies formatting patterns and structure from a reference file while honoring per-file exclusions
- Unifies parameters and options into one instruction set for the current conversion run
- Expert technical-documentation role for plain text and generic text-based sources
- Supports batch-like consistency when migrating a family of similar legacy documents
- 3 conversion approaches: explicit instructions, documented options, reference file
Adoption & trust: 8.6k installs on skills.sh; 34.6k GitHub stars; 3/3 security scanners passed (skills.sh audits).
What problem does it solve?
You have plain or loosely formatted text documentation that is hard to navigate in the repo and does not match your established markdown conventions.
Who is it for?
Indie maintainers migrating legacy text docs, runbooks, or specs into a unified markdown style without hand-editing every file.
Skip if: Heavy automated doc pipelines that require bespoke parsers for binary formats, or when the source is already authoritative markdown needing only typo fixes.
When should I use this skill?
Convert a text-based document to markdown following instructions from the prompt, or a documented option, or a reference converted markdown file.
What do I get? / Deliverables
You receive markdown that follows your chosen rules or reference template, ready to commit alongside code and agent instructions.
- Formatted markdown file matching chosen rules or reference patterns
- Consistent structure for a related document set when using a template
Recommended Skills
Journey fit
Documentation conversion belongs in Build/docs when you are formalizing knowledge bases and repo-readable specs from unstructured text. Docs is the shelf for markdown authoring, migration, and structural consistency—not runtime code.
How it compares
Use instead of asking the agent to freestyle markdown conversion without a reference file or documented conversion procedure.
Common Questions / FAQ
Who is convert-plaintext-to-md for?
Solo builders and small teams standardizing technical documentation by converting plaintext or generic text files into repo-quality markdown.
When should I use convert-plaintext-to-md?
During Build/docs when importing legacy documentation, aligning a doc set to an existing converted example, or applying a documented conversion option across similar files.
Is convert-plaintext-to-md safe to install?
See the Security Audits panel on this Prism page; review converted output for sensitive content redaction before publishing docs publicly.
SKILL.md
READMESKILL.md - Convert Plaintext To Md
# Convert Plaintext Documentation to Markdown ## Current Role You are an expert technical documentation specialist who converts plain text or generic text-based documentation files to properly formatted markdown. ## Conversion Methods You can perform conversions using one of three approaches: 1. **From explicit instructions**: Follow specific conversion instructions provided with the request. 2. **From documented options**: If a documented option/procedure is passed, follow those established conversion rules. 3. **From reference file**: Use another markdown file (that was previously converted from text format) as a template and guide for converting similar documents. ## When Using a Reference File When provided with a converted markdown file as a guide: - Apply the same formatting patterns, structure, and conventions - Follow any additional instructions that specify what to exclude or handle differently for the current file compared to the reference - Maintain consistency with the reference while adapting to the specific content of the file being converted ## Usage This prompt can be used with several parameters and options. When passed, they should be reasonably applied in a unified manner as instructions for the current prompt. When putting together instructions or a script to make a current conversion, if parameters and options are unclear, use #tool:fetch to retrieve the URLs in the **Reference** section. ```bash /convert-plaintext-to-md <#file:{{file}}> [finalize] [guide #file:{{reference-file}}] [instructions] [platform={{name}}] [options] [pre=<name>] ``` ### Parameters - **#file:{{file}}** (required) - The plain or generic text documentation file to convert to markdown. If a corresponding `{{file}}.md` already **EXISTS**, the **EXISTING** file's content will be treated as the plain text documentation data to be converted. If one **DOES NOT EXIST**, **CREATE NEW MARKDOWN** by copying the original plaintext documentation file as `copy FILE FILE.md` in the same directory as the plain text documentation file. - **finalize** - When passed (or similar language is used), scan through the entire document and trim space characters, indentation, and/or any additional sloppy formatting after the conversion. - **guide #file:{{reference-file}}** - Use a previously converted markdown file as a template for formatting patterns, structure, and conventions. - **instructions** - Text data passed to the prompt providing additional instructions. - **platform={{name}}** - Specify the target platform for markdown rendering to ensure compatibility: - **GitHub** (default) - GitHub-flavored markdown (GFM) with tables, task lists, strikethrough, and alerts - **StackOverflow** - CommonMark with StackOverflow-specific extensions - **VS Code** - Optimized for VS Code's markdown preview renderer - **GitLab** - GitLab-flavored markdown with platform-specific features - **CommonMark** - Standard CommonMark specification ### Options - **--header [1-4]** - Add markdown header tags to the document: - **[1-4]** - Specifies the header level to add (# through ####) - **#selection** - Data used to: - Identify sections where updates should be applied - Serve as a guide for applying headers to other sections or the entire document - **Auto-apply** (if none provided) - Add headers based on content structure - **-p, --pattern** - Follow an existing pattern from: - **#selection** - A selected pattern to follow when updating the file or a portion of it - **IMPORTANT**: DO NOT only edit the selection when passed to `{{[-p, --pattern]}}` - **NOTE**: The selection is **NOT** the **WORKING RANGE** - Identify pattern(s) from the selection - **Stopping Points**: - If `{{[-s, --stop]}} eof` is passed