skills.rest
ortus-boxlang
ortus-boxlangOFFICIAL
Explore all skills by this author →
Website𝕏@tryboxlangGitHub

bx-docbox

Generate HTML, JSON, and UML/XMI API documentation from BoxLang source code.

Updated Apr 10, 2026
Search Tags:#documentation#html#api#cli#boxlang#docbox
One-click install
npx skills add https://github.com/ortus-boxlang/skills --skill bx-docbox
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bx-docbox
Source: https://github.com/ortus-boxlang/skills/tree/main/boxlang-modules/bx-docbox
Command: npx skills add https://github.com/ortus-boxlang/skills --skill bx-docbox

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

DocBox automates API documentation generation from BoxLang source code, ensuring up-to-date, navigable docs.

Core Features & Use Cases

  • CLI usage through boxlang module:docbox to generate docs from a BoxLang source directory.
  • Programmatic usage via DocBox.addStrategy().generate() for integration into CI and custom workflows.
  • Output formats include HTML (SPA and frames), JSON metadata, and UML/XMI diagrams.
  • Project title configuration, source exclusion rules, and seamless CommandBox integration.

Quick Start

Execute the DocBox generator against your BoxLang source to produce HTML, JSON, and UML API documentation.

Frequently Asked Questions about bx-docbox

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

FAQPage Schema
How do I generate API documentation from BoxLang source code?▼

You can generate API documentation from BoxLang source code by running the DocBox generator via the boxlang module:docbox CLI command or by using DocBox.addStrategy().generate() programmatically in your workflows.

What output formats are available for BoxLang API docs?▼

BoxLang API documentation can be rendered as HTML single-page applications, HTML frames, JSON metadata, and UML/XMI diagrams to suit different browsing and integration needs.

Can I exclude specific source files when generating BoxLang API documentation?▼

Yes, you can configure source exclusion rules when generating BoxLang API documentation with DocBox, allowing you to omit specific directories or files from the final output.

Does DocBox integrate with CommandBox for automated documentation generation?▼

DocBox offers seamless CommandBox integration, enabling you to automate API documentation generation directly within your BoxLang tooling and continuous integration workflows.

How do I add a custom project title to my BoxLang API documentation?▼

You can configure an optional project title during generation to brand your BoxLang API documentation, ensuring the output HTML SPA or frames display the correct project name.

What is the best way to automate BoxLang API documentation in a CI pipeline?▼

The best way to automate BoxLang API documentation in CI pipelines is by using the programmatic DocBox.addStrategy().generate() method to render HTML, JSON, and UML outputs automatically.

Related Skills

Explore More Software Engineering Skills→
ColdBoxColdBox

coldbox-docbox-generation

Generate API documentation from BoxLang and CFML source code.

Official
Intermediate
atanakaatanaka

json-to-models

Regenerate UML, XMI, and architecture docs from domain-model.json.

Community
Advanced
ortus-docsortus-docs
16

boxlang-runtime-github-actions

Automate BoxLang setup in GitHub Actions workflows.

Official
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate