md-craft

Generate and update project Markdown files using detected archetype and tone.

4|Updated Apr 18, 2026
One-click install
npx skills add https://github.com/valetivivek/md-craft-skill --skill md-craft
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: md-craft
Source: https://github.com/valetivivek/md-craft-skill/tree/main/skills/md-craft
Command: npx skills add https://github.com/valetivivek/md-craft-skill --skill md-craft

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing and maintaining Markdown documentation for projects is repetitive and prone to drift; teams struggle to keep READMEs, templates, and docs consistent with their voice and tone.

Core Features & Use Cases

  • Auto-detects project archetype (library, app, CLI, etc.) and tone, then writes or updates Markdown in the repo.
  • Applies per-repo preferences stored in a hidden JSON file to preserve consistency across runs.
  • Generates READMEs, PR templates, CONTRIBUTING, and CHANGELOGs that match the project's existing voice.
  • Supports referencing existing CLAUDE.md or CLAUDE-like docs to inform style.

Quick Start

Ask for the archetype and tone, then generate and update the repository's Markdown files accordingly.

Frequently Asked Questions about md-craft

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

FAQPage Schema
How do I automate generating and updating project Markdown documentation?

Automating project Markdown documentation involves detecting the repo archetype and tone, then generating READMEs, PR templates, CONTRIBUTING, and CHANGELOGs. This Skill stores per-repo preferences in a hidden JSON file to maintain consistent voice across subsequent runs.

How do I keep my README and CHANGELOG consistent with my project's tone?

To keep README and CHANGELOG files consistent, the Skill detects the project's archetype and tone, persists these preferences in a per-repo JSON, and applies them on subsequent runs. It can optionally consult existing CLAUDE.md or similar docs to inform the writing style.

Do I need a specific file format to start generating Markdown files for my repository?

You do not need a specific file format, but the Skill relies on a SKILL.md frontmatter that provides name and description. It parses the YAML metadata to seed behavior and can optionally reference existing CLAUDE.md docs to inform style without overwriting your content.

Can I generate PR templates and CONTRIBUTING docs that match my library or CLI app?

Yes, you can generate PR templates and CONTRIBUTING docs that match your library or CLI app. The Skill auto-detects the project archetype, whether it is a library, app, or CLI, and writes Markdown files that align with the project's existing voice and tone.

What is the best way to maintain consistent voice across multiple Markdown files in a repo?

Maintaining consistent voice across Markdown files is best handled by persisting per-repo preferences in a hidden JSON file. The Skill applies these stored preferences on subsequent runs to ensure that READMEs, docs, and templates remain uniform over time.

Will this Markdown documentation generator overwrite my existing repository content?

The Markdown documentation generator will not overwrite your existing content. It optionally consults referenced guidance like CLAUDE.md to inform style and applies per-repo preferences to generate or update files without overwriting user content already present in the repository.