██████╗  ██████╗  ██████╗██████╗  ██████╗ ██╗  ██╗
██╔══██╗██╔═══██╗██╔════╝██╔══██╗██╔═══██╗╚██╗██╔╝
██║  ██║██║   ██║██║     ██████╔╝██║   ██║ ╚███╔╝
██║  ██║██║   ██║██║     ██╔══██╗██║   ██║ ██╔██╗
██████╔╝╚██████╔╝╚██████╗██████╔╝╚██████╔╝██╔╝ ██╗
╚═════╝  ╚═════╝  ╚═════╝╚═════╝  ╚═════╝ ╚═╝  ╚═╝

📚 DocBox - API Documentation Generator

DocBox is a JavaDoc-style documentation generator for BoxLang and CFML codebases, featuring modern HTML themes, JSON output, and UML diagram generation.

📖 Documentation | 💻 GitHub | 💬 Ortus Community

✨ Features

• 🎨 Modern HTML Documentation - Two professional themes with dark mode support
• 🔍 Real-time Search - Live method filtering with keyboard navigation
• 📋 Multiple Output Formats - HTML, JSON, and XMI/UML diagrams
• 🦤 BoxLang Native - First-class BoxLang runtime and CLI support
• 📝 JavaDoc Compatible - Standard JavaDoc comment block parsing
• ⚡ Alpine.js SPA - Fast, modern single-page application interface
• 🌓 Dark Mode - System preference detection with manual toggle

🚀 Quick Start

BoxLang Module (Recommended)

Install DocBox as a BoxLang module for CLI access:

# CommandBox web runtimes
box install bx-docbox

# BoxLang OS runtime
install-bx-module bx-docbox

Generate documentation from the command line:

boxlang module:docbox --source=/path/to/code \
                       --mapping=myapp \
                       --output-dir=/docs \
                       --project-title="My API"

CFML Library

Install as a development dependency:

box install docbox --saveDev

Use programmatically in your build scripts:

new docbox.DocBox()
    .addStrategy( "HTML", {
        projectTitle : "My API Docs",
        outputDir    : expandPath( "./docs" ),
        theme        : "default"  // or "frames"
    })
    .generate(
        source   = expandPath( "./models" ),
        mapping  = "models",
        excludes = "(tests|build)"
    );

📦 Installation Options

🎨 Modern Themes

Default Theme (Alpine.js SPA)

• ⚡ Client-side routing and dynamic filtering
• 🌓 Dark mode with localStorage persistence
• 🔍 Real-time method search
• 📑 Method tabs (All/Public/Private/Static/Abstract)
• 💜 Modern purple gradient design

Frames Theme (Traditional)

• 🗂️ Classic frameset layout
• 📚 jstree navigation sidebar
• 🎯 Bootstrap 5 styling
• 📱 Mobile-friendly design

💻 System Requirements

• BoxLang 1.0+ or CFML Engine (Lucee 5+, Adobe ColdFusion 2023+)
• CommandBox (for installation and CLI usage)

📚 Output Formats

🛠️ CLI Examples

BoxLang Module CLI

# Basic usage
boxlang module:docbox --source=/src --mapping=app --output-dir=/docs

# Multiple source mappings
boxlang module:docbox --mappings:v1=/src/v1 --mappings:v2=/src/v2 -o=/docs

# With theme selection
boxlang module:docbox --source=/src --mapping=app --theme=frames -o=/docs

# Show help
boxlang module:docbox --help

CommandBox Task Runner

Install the commandbox-docbox module:

box install commandbox-docbox

Generate documentation using CommandBox commands:

# Generate HTML docs
box docbox generate source=/path/to/code mapping=myapp outputDir=/docs

# Generate with excludes
box docbox generate source=/src mapping=app outputDir=/docs excludes=(tests|build)

# Generate JSON docs
box docbox generate source=/src mapping=app outputDir=/docs strategy=JSON

# Show help
box docbox generate help

Use in a task.cfc for automated builds:

component {
    function run() {
        command( "docbox generate" )
            .params(
                source    = getCWD() & "/models",
                mapping   = "models",
                outputDir = getCWD() & "/docs",
                excludes  = "tests"
            )
            .run();
    }
}

📖 Documentation

Complete documentation is available at docbox.ortusbooks.com

• Getting Started
• BoxLang CLI Tool
• Configuration
• Annotating Your Code
• HTML Output
• JSON Output

🔗 Related Projects

• commandbox-docbox - CommandBox module for task runner integration
• bx-docbox - BoxLang native module with CLI

🐛 Issues & Feature Requests

Found a bug or have an idea? Report it on our Jira issue tracker

💬 Community & Support

• 💬 CFML Slack - #box-products channel
• 🗨️ Ortus Community Forums
• 📧 Professional Support

🙏 Credits

Thanks to Mark Mandel for the original project that inspired DocBox.

📄 License

Apache License, Version 2.0

✝️ The Daily Bread

"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" - John 14:6