From e1c878369c1117d9d37f45e59a7399bde05388a6 Mon Sep 17 00:00:00 2001 From: Luis Majano Date: Tue, 13 Feb 2024 12:47:06 +0100 Subject: [PATCH] removing emojis to publish --- changelog.md | 6 +++--- readme.md | 19 ++++++++----------- 2 files changed, 11 insertions(+), 14 deletions(-) diff --git a/changelog.md b/changelog.md index 6a02aaa..8bc650b 100644 --- a/changelog.md +++ b/changelog.md @@ -20,17 +20,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Removal of `box.zip` in root from old scripts -### ⚠ BREAKING +### BREAKING - Dropped support for Adobe 2016. Adobe doesn't support ACF 16 anymore, so neither do we. -### 📦 NEW +### NEW - Added support for Adobe 2021 - Added support for `@myCustomTag` custom docblock tags on methods. (Already supported on components and properties, but missing on methods). - Added GitHub Actions CI for automated testing, format checking, releases and more -### 🐛 FIX +### FIX - Fixes support for Adobe 2018. (Mainly in the CommandBox strategy.) diff --git a/readme.md b/readme.md index 7516945..5455819 100644 --- a/readme.md +++ b/readme.md @@ -1,16 +1,12 @@ [![All Contributors](https://img.shields.io/github/contributors/Ortus-Solutions/DocBox?style=flat-square)](https://github.com/michaelborn/DocBox/graphs/contributors) | -[![Master Branch Build Status](https://img.shields.io/travis/Ortus-Solutions/DocBox/master.svg?style=flat-square&label=master)](https://travis-ci.org/Ortus-Solutions/DocBox) -| -[![Development Branch Build Status](https://img.shields.io/travis/Ortus-Solutions/DocBox/development.svg?style=flat-square&label=development)](https://travis-ci.org/Ortus-Solutions/DocBox) -| ![Latest release](https://img.shields.io/github/v/release/Ortus-Solutions/DocBox?style=flat-square) ```text ██████╗ ██████╗ ██████╗██████╗ ██████╗ ██╗ ██╗ ██╔══██╗██╔═══██╗██╔════╝██╔══██╗██╔═══██╗╚██╗██╔╝ -██║ ██║██║ ██║██║ ██████╔╝██║ ██║ ╚███╔╝ -██║ ██║██║ ██║██║ ██╔══██╗██║ ██║ ██╔██╗ +██║ ██║██║ ██║██║ ██████╔╝██║ ██║ ╚███╔╝ +██║ ██║██║ ██║██║ ██╔══██╗██║ ██║ ██╔██╗ ██████╔╝╚██████╔╝╚██████╗██████╔╝╚██████╔╝██╔╝ ██╗ ╚═════╝ ╚═════╝ ╚═════╝╚═════╝ ╚═════╝ ╚═╝ ╚═╝ ``` @@ -33,8 +29,8 @@ DocBox is a JavaDoc-style documentation generator for your CFML codebase based o ## SYSTEM REQUIREMENTS -- Lucee 5+ -- ColdFusion 2016+ +* Lucee 5+ +* ColdFusion 2016+ ## Usage @@ -42,7 +38,7 @@ Use the DocBox library to generate API docs from your CFC files. Install Docbox ```bash box install docbox -``` +``` ### Standalone Application @@ -55,8 +51,8 @@ docbox = new docbox.DocBox( strategy="class.path", properties={} ); // create with HTML strategy docbox = new docbox.DocBox( strategy = "HTML", - properties = { - projectTitle="My Docs", + properties = { + projectTitle="My Docs", outputDir="#expandPath( '/docs' )#" } ); @@ -103,6 +99,7 @@ There is a related project you can install which wraps up the DocBox library in ```bash box install commandbox-docbox ``` + Read more here: https://github.com/Ortus-Solutions/commandbox-docbox ----