{"id":20141487,"url":"https://github.com/michaelborn/docbox-actions-test","last_synced_at":"2026-07-05T19:31:17.312Z","repository":{"id":53756299,"uuid":"333082035","full_name":"michaelborn/docbox-actions-test","owner":"michaelborn","description":"Testing Github Actions with DocBox","archived":false,"fork":false,"pushed_at":"2021-03-15T21:45:03.000Z","size":1176,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"ACTIONS_TEST","last_synced_at":"2025-08-25T23:35:59.815Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/michaelborn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-26T12:44:00.000Z","updated_at":"2021-03-01T20:54:25.000Z","dependencies_parsed_at":"2022-09-14T11:40:55.058Z","dependency_job_id":null,"html_url":"https://github.com/michaelborn/docbox-actions-test","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/michaelborn/docbox-actions-test","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelborn%2Fdocbox-actions-test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelborn%2Fdocbox-actions-test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelborn%2Fdocbox-actions-test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelborn%2Fdocbox-actions-test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaelborn","download_url":"https://codeload.github.com/michaelborn/docbox-actions-test/tar.gz/refs/heads/ACTIONS_TEST","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelborn%2Fdocbox-actions-test/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281376602,"owners_count":26490317,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-28T02:00:06.022Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T21:57:28.734Z","updated_at":"2025-10-28T02:47:16.102Z","avatar_url":"https://github.com/michaelborn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![All Contributors](https://img.shields.io/github/contributors/Ortus-Solutions/DocBox?style=flat-square)](https://github.com/michaelborn/DocBox/graphs/contributors)\n|\n[![Master Branch Build Status](https://img.shields.io/travis/Ortus-Solutions/DocBox/master.svg?style=flat-square\u0026label=master)](https://travis-ci.org/Ortus-Solutions/DocBox) \n| \n[![Development Branch Build Status](https://img.shields.io/travis/Ortus-Solutions/DocBox/development.svg?style=flat-square\u0026label=development)](https://travis-ci.org/Ortus-Solutions/DocBox)\n|\n![Latest release](https://img.shields.io/github/v/release/Ortus-Solutions/DocBox?style=flat-square)\n\n```text\n██████╗  ██████╗  ██████╗██████╗  ██████╗ ██╗  ██╗\n██╔══██╗██╔═══██╗██╔════╝██╔══██╗██╔═══██╗╚██╗██╔╝\n██║  ██║██║   ██║██║     ██████╔╝██║   ██║ ╚███╔╝ \n██║  ██║██║   ██║██║     ██╔══██╗██║   ██║ ██╔██╗ \n██████╔╝╚██████╔╝╚██████╗██████╔╝╚██████╔╝██╔╝ ██╗\n╚═════╝  ╚═════╝  ╚═════╝╚═════╝  ╚═════╝ ╚═╝  ╚═╝\n```\n\n# Welcome to DocBox!\n\nDocBox is a JavaDoc-style documentation generator for your CFML codebase based on Mark Mandel's ColdDoc project.\n\n[Docs][1] | [Github][2] | [Ortus Community][3]\n\n![Coldbox 5 Router class documentation, generated via DocBox](coldbox-5-router-documentation.png)\n\n## FEATURES\n\n* Read [JavaDoc comment blocks](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#format)\n* Document your class API - components, methods, and properties\n* Generate HTML documentation\n* Generate machine-readable JSON\n* generate XMI file which can be converted to a UML diagram\n\n## SYSTEM REQUIREMENTS\n\n- Lucee 5+\n- Adobe ColdFusion 2016+\n\n## Usage\n\nUse the DocBox library to generate API docs from your CFC files.  Install Docbox with CommandBox like so:\n\n```bash\nbox install docbox\n```  \n\n### Standalone Application\n\nIf you want to use DocBox for document generation in your CFML application, then just drop it into any location and create a `/docbox` mapping to it.  You will then instantiate the `DocBox` generator class with a `strategy` and `properties` for the strategy.\n\n```js\n// use custom strategy found at class.path\ndocbox = new docbox.DocBox( strategy=\"class.path\", properties={} );\n\n// create with HTML strategy\ndocbox = new docbox.DocBox(\n  strategy = \"HTML\",\n  properties = { \n    projectTitle=\"My Docs\", \n    outputDir=\"#expandPath( '/docs' )#\"\n  }\n);\n```\n\n#### Generating Docs\n\nTo generate the documentation you will then execute the `generate()` method on the DocBox object and pass in the following parameters:\n\n#### Generate Params\n\n* `source` : A path to the source location or an array of structs of locations that must have a `dir` and `mapping` key on it.\n* `mapping` : The base mapping for the folder source. Used only if `source` is a path\n* `excludes` : A regular expression that will be evaluated against all CFCs sent for documentation.  If the regex matches the CFC name and path then the CFC will be excluded from documentation.\n\n\n```js\ndocbox.generate( source=\"/my/path\", mapping=\"coldbox\" );\n\ndocbox.generate(\n    source  = \"#expandPath( '/docbox' )#\",\n    mapping = \"coldbox\",\n    excludes = \"tests\"\n);\n```\n\nOnce the generation finalizes, you will see your beautiful docs!\n\n#### Available Strategies \u0026 Properties\n\n* `HTML` - **default**\n  * `projectTitle` : The HTML title\n  * `outputDir` : The output directory\n* `JSON`\n  * `projectTitle` : The HTML title\n  * `outputDir` : The output directory\n* `XMI`\n  * `outputFile` : The output file\n\n### CommandBox Command\n\nThere is a related project you can install which wraps up the DocBox library in a Custom CLI command so you can generate API docs from the command line.\n\n```bash\nbox install commandbox-docbox\n```\nRead more here: https://github.com/Ortus-Solutions/commandbox-docbox\n\n----\n\n## LICENSE\n\nApache License, Version 2.0.\n\n## BUGS + NEW FEATURES\n\nPlease use our Jira instance to create bugs and new feature issues: https://ortussolutions.atlassian.net/projects/DOCBOX\n\n## CREDITS \u0026 CONTRIBUTIONS\n\nThanks to Mark Mandel for allowing us to fork his project.\n\nI THANK GOD FOR HIS WISDOM FOR THIS PROJECT\n\n## THE DAILY BREAD\n\n\"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)\" Jn 14:1-12\n\n[1]: https://docbox.ortusbooks.com/\n[2]: https://github.com/Ortus-Solutions/DocBox\n[3]: https://community.ortussolutions.com/c/communities/docbox/17\n\n## Have Questions?\n\nCome find us on the [CFML Slack](http://cfml-slack.herokuapp.com/) (#box-products channel) and ask us there.  We'd be happy to help!\n\n## Ortus Community\n\nJoin us in our Ortus Community and become a valuable member of this project https://community.ortussolutions.com/c/communities/docbox/17. We are looking forward to hearing from you!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelborn%2Fdocbox-actions-test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelborn%2Fdocbox-actions-test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelborn%2Fdocbox-actions-test/lists"}