| name | markdown-editor |
| description | Create, write, generate, edit, update, and format markdown documentation (README, CHANGELOG, research notes, plans, guides, tutorials). Handles frontmatter metadata, directory organization, and file naming. Use when writing .md files, documenting code, creating project docs, saving research findings, building README files, managing TODO lists, or generating any markdown content. |
| version | 1.0.1 |
| license | MIT |
| metadata | {"audience":"developers, agents","workflow":"documentation"} |
Quick Start
Prerequisites:
- Git configured (
git config user.name for author extraction)
- Write access to target directory
Tools Used: Read, Write, Edit, Bash (for git config, mkdir)
Basic Usage:
- Determine document type (research, plan, docs, README, TODO, CHANGELOG)
- Choose location based on type
- Create directory if needed
- Write with appropriate frontmatter (or none for special files)
When to Use Me
Use this skill when you:
- Create, write, or generate new markdown (.md) files
- Edit, update, or modify existing markdown content
- Write research notes, findings, or analysis documents
- Create implementation plans, strategies, or roadmaps
- Build or update README files for projects or modules
- Manage TODO lists or CHANGELOG files
- Need to save agent research findings persistently
Additional Triggers
Also use this skill when you:
- Fix markdown lint issues or formatting problems
- Reflow or wrap long lines in documentation
- Validate frontmatter structure or fix schema issues
- Check or fix broken links in documentation
What I Do
- Create and edit markdown files with consistent structure
- Apply YAML frontmatter (title, author, timestamps, type, tags)
- Organize docs by type: research →
./docs/research/, plans → ./docs/plans/
- Handle special files (README, TODO, CHANGELOG) without frontmatter
- Generate descriptive kebab-case filenames
- Extract author from git config, manage ISO 8601 timestamps
Document Type Quick Reference
| Type | Location | Frontmatter | Trigger Words |
|---|
| Research | ./docs/research/ | Yes | research, analyze, investigate, explore |
| Plan | ./docs/plans/ | Yes | plan, strategy, roadmap, implementation |
| General | ./docs/ | Yes | document, guide, notes |
| README | Project/module root | No | readme, overview, project docs |
| TODO | Project root | No | todo, tasks, action items |
| CHANGELOG | Project root | No | changelog, releases, versions |
Frontmatter Template
---
title: Descriptive Title
created: 2025-12-25T14:30:00Z
last_modified: 2025-12-25T14:30:00Z
author: John Doe
type: research|plan|documentation
tags: [tag1, tag2]
---
Common Errors
| Error | Cause | Solution |
|---|
| Directory not found | Target path doesn't exist | Create with mkdir -p ./docs/research/ |
| Author is "Unknown" | Git not configured | Run git config user.name "Your Name" |
| Frontmatter on README | Applied template to special file | README, TODO, CHANGELOG skip frontmatter |
| Filename collision | Generic name already exists | Use more specific descriptive name |
| Invalid timestamp | Wrong date format | Use ISO 8601 with UTC: 2025-12-25T14:30:00Z |
References
| Reference | Load When |
|---|
| examples.md | Need concrete examples of creating/editing documents |
| document-types.md | Need detailed guidance on document type conventions |
Validation Checklist
