markdown-editor

Polish Markdown files to meet best-practice formatting and readability.

Updated Nov 13, 2025
One-click install
npx skills add https://github.com/iop098321qwe/dotfiles-arch --skill markdown-editor-iop098321qwe
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-editor
Source: https://github.com/iop098321qwe/dotfiles-arch/tree/main/dot_config/opencode/skills/markdown-editor
Command: npx skills add https://github.com/iop098321qwe/dotfiles-arch --skill markdown-editor-iop098321qwe

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Edit or update Markdown files (.md) following best practices and industry standards. ALWAYS use for any .md edit or review, even if the user does not explicitly request it, unless the file is inside a directory that contains a .obsidian/ folder (treat as Obsidian vault and do not use this skill).

Core Features & Use Cases

  • Always apply this skill for any .md edit or review unless Obsidian exception applies.
  • Use GitHub Flavored Markdown unless the repo specifies otherwise.
  • Preserve the existing file style and structure.
  • Keep heading levels consistent and sequential.
  • Add blank lines around headings, lists, and code blocks.
  • Avoid raw HTML unless Markdown cannot express the requirement.
  • Default to 80 characters per line, but preserve the established line-length convention when clearly present.

Quick Start

Edit the markdown document to align headings, spacing, and style with the defined Markdown guidelines.

Frequently Asked Questions about markdown-editor

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

FAQPage Schema
How do I format Markdown files to follow consistent heading and spacing standards?

To format Markdown files, apply best-practice rules that normalize heading levels sequentially, add blank lines around headings and code blocks, and default to 80 characters per line while preserving existing style.

What is the best way to enforce line-length limits in Markdown documentation?

The best way to enforce line-length limits in Markdown is applying a linting process that defaults to 80 characters per line but preserves the established line-length convention when one is clearly present in the file.

Does Markdown formatting work with Obsidian vault files?

Markdown formatting does not work with Obsidian vault files; any file inside a directory containing a .obsidian/ folder is skipped to respect Obsidian-specific structures and prevent unwanted modifications.

How do I preserve existing content style when editing Markdown code repositories?

To preserve existing content style when editing Markdown, apply GitHub Flavored Markdown rules unless specified otherwise, maintaining the original structure and avoiding raw HTML unless Markdown cannot express the requirement.

When should I add blank lines around lists and code blocks in Markdown?

You should always add blank lines around lists and code blocks in Markdown to improve readability and ensure proper rendering across different parsers and documentation platforms.

Can I use raw HTML tags in Markdown documentation drafts?

You should avoid raw HTML tags in Markdown documentation drafts unless Markdown cannot express the specific requirement, ensuring the content remains portable and follows standard GitHub Flavored Markdown syntax.