coldbox-docbox-generation
OfficialGenerate API docs for BoxLang and CFML projects
AuthorColdBox
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This skill streamlines configuring and running DocBox to produce consistent, navigable API documentation for BoxLang and CFML codebases, removing uncertainty about strategies, mappings, excludes, themes, and CLI or build integrations.
Core Features & Use Cases
- Flexible output strategies: Configure and run HTML, JSON, UML, CommandBox, or custom template strategies, and combine multiple strategies in a single run.
- Source mapping and exclusions: Support single or multiple source directories with mapping entries and exclude patterns to omit tests, build artifacts, or dotfolders.
- CLI and build integration: Execute DocBox from BoxLang CLI, CommandBox CLI, or integrate into ColdBox build tasks with configurable output directories and themes.
- Use Case: Produce both user-facing HTML docs and machine-readable JSON indexes for a microservice repository while excluding test and generated code folders.
Quick Start
Generate API docs for the project at /app using mapping app and output the results to /docs.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: coldbox-docbox-generation Download link: https://github.com/ColdBox/skills/archive/main.zip#coldbox-docbox-generation Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.