From ccfg-markdown
Initialize documentation structure and templates (README, ADR, API docs, changelog, contributing)
How this command is triggered — by the user, by Claude, or both
Slash command
/ccfg-markdown:scaffold [--type=readme|adr|api-docs|changelog|contributing]This command is limited to the following tools:
The summary Claude sees in its command listing — used to decide when to auto-load this command
# scaffold Initialize documentation structure and templates for projects. Generates well-structured documentation files based on project type detection and standard patterns. ## Usage ## Scaffold Types ### readme (default) Generate a structured README.md for the project. **Steps**: 1. Detect project type from project files (language, framework, CLI vs library vs service) 2. Generate structured README.md: title, badges placeholder, description, prerequisites, installation, usage, configuration, development, testing, contributing reference, license 3. Sections ordered by reader ne...
Initialize documentation structure and templates for projects. Generates well-structured documentation files based on project type detection and standard patterns.
ccfg markdown scaffold # Default: scaffold README
ccfg markdown scaffold --type=readme # Generate structured README
ccfg markdown scaffold --type=adr # Generate ADR directory and template
ccfg markdown scaffold --type=api-docs # Generate API documentation structure
ccfg markdown scaffold --type=changelog # Generate CHANGELOG.md
ccfg markdown scaffold --type=contributing # Generate CONTRIBUTING.md
Generate a structured README.md for the project.
Steps:
Project type detection:
package.json -> Node.js project (check for framework: express, next, react, etc.)
requirements.txt -> Python project (check for framework: django, flask, fastapi, etc.)
go.mod -> Go project
Cargo.toml -> Rust project
pom.xml / build.gradle -> Java project
Gemfile -> Ruby project
composer.json -> PHP project
Generated sections:
# Project Name
<!-- badges -->
One-sentence description.
## Table of Contents
## Prerequisites
## Installation
## Usage
## Configuration
## Development
## Testing
## Contributing
## License
Generate an Architecture Decision Records directory and template.
Steps:
<doc-root>/adr/<doc-root>/adr/README.md) linking all decision recordsGenerated files:
<doc-root>/adr/
├── README.md (ADR index)
└── template.md (blank ADR template)
Generate API documentation structure.
Steps:
Generated files:
<doc-root>/api/
├── README.md (API overview)
├── authentication.md (auth methods and tokens)
└── endpoints.md (endpoint reference)
Generate a CHANGELOG.md following Keep a Changelog format.
Steps:
Generated structure:
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
### Changed
### Fixed
Generate a CONTRIBUTING.md for the project.
Steps:
Always check if a file exists before creating it. If the target file already exists, skip with a notice. Never silently overwrite documentation.
README.md already exists. Skipping scaffold.
To regenerate, rename or remove the existing file first.
Detection is best-effort. Never prescribe a stack — respect what the project already uses. Use project files to detect language, framework, and tooling.
Check for existing documentation directories in this order:
docs/ (preferred)doc/documentation/Use the first match as the doc root for all generated output. If none exists, use docs/ as the
default for new projects.
All scaffold types respect this detected root:
<doc-root>/adr/, not hardcoded docs/adr/<doc-root>/api/, not hardcoded docs/api/Scaffold recommends creating a conventions document at <doc-root>/markdown-conventions.md. If the
doc root directory exists, scaffold offers to create it. If no doc root structure exists, skip and
note in output.
npx claudepluginhub jsamuelsen11/claude-config --plugin ccfg-markdown/initInitializes docs folder with minimal, standard, or full structure, creating directories and README files with navigation, placeholders, and project analysis. Supports --check preview and --force overwrite.
/docsGenerate or update project documentation from codebase and specs. Scopes: api|readme|deploy|all. Scans files, drafts for approval, tracks in todo.md.
/create-mdAnalyzes project structure and generates CLAUDE.md files in root and key subdirectories with overview, setup/run commands, code styles, workflows, and conventions.
/indexGenerates project documentation, knowledge base, API docs, structure analysis, or README for a target path. Supports --type (docs|api|structure|readme) and --format (md|json|yaml).
/scaffoldScaffolds Next.js App Router pages, layouts, server/client components, API routes, server actions, and loading/error states following best practices and project patterns.
/scaffoldScaffolds production-ready project for API, web, CLI, lib, or fullstack using TypeScript, Python, Go, or Rust. Includes src/tests, Docker, GitHub Actions CI/CD, git init, deps, and verification.