github-action-readme-generator 1.8.10 → 1.9.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.9.1](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.9.0...v1.9.1) (2026-01-28)
+
+
+### Bug Fixes
+
+* disambiguate duplicate TOC anchors and persist empty TOC ([767a192](https://github.com/bitflight-devops/github-action-readme-generator/commit/767a192f871de95f14a66d1e6aa677df8f97334d))
+
+# [1.9.0](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.8.10...v1.9.0) (2026-01-28)
+
+
+### Features
+
+* implement table of contents generation for contents section ([3e9a0a4](https://github.com/bitflight-devops/github-action-readme-generator/commit/3e9a0a4e1f1180c94ea0666b12abeb5ed325afdd))
+
 ## [1.8.10](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.8.9...v1.8.10) (2026-01-25)
 
 

package/README.md

@@ -1,3 +1,9 @@
+<div align="center">
+
+<img src=".github/hero.png" alt="GitHub Action README Generator" width="800" />
+
+</div>
+
 <div align="center" >
 <!-- start title -->
 
@@ -14,15 +20,43 @@
 </div>
 <!-- start description -->
 
-📓 Effortlessly sync action.yml to README.md. Auto-generates inputs, outputs & usage docs, ensuring docs match code.
+📓 The docs generator for GitHub Actions. Auto-syncs action.yml → README.md with 8 sections including inputs, outputs, usage, badges & branding. Sensible defaults, highly configurable.
 
 <!-- end description -->
 
-📓 Keep your action's README.md up to date with the `title` and `description` from the [`action.yml`](./action.yml) file, while also automatically generating sections for the inputs, outputs, and a usage example for the action. Additionally the Action's usage example is updated to match the Action's current release.
+## Quick Start
+
+```sh
+npx github-action-readme-generator
+```
+
+That's it. Run this in your GitHub Action repository and your README.md is updated.
+
+## Features
+
+|                    | Feature             | Description                                                  |
+| :----------------: | ------------------- | ------------------------------------------------------------ |
+| :white_check_mark: | **Inputs Table**    | Auto-generates markdown table from `action.yml` inputs       |
+| :white_check_mark: | **Outputs Table**   | Auto-generates markdown table from `action.yml` outputs      |
+| :white_check_mark: | **Usage Example**   | Creates ready-to-copy YAML workflow snippet                  |
+| :white_check_mark: | **Auto-Versioning** | Updates `uses: owner/repo@v1.2.3` on every release           |
+| :white_check_mark: | **GitHub Badges**   | Adds release, commit, issues, and download badges            |
+| :white_check_mark: | **SVG Branding**    | Generates icon from action.yml branding (100+ icons)         |
+| :white_check_mark: | **Easy Setup**      | Add section markers to README, configure via `.ghadocs.json` |
+| :white_check_mark: | **Dual Mode**       | Use as CLI (`npx`) or GitHub Action in workflows             |
+
+## How It Works
+
+This tool uses markdown comments as section markers in your README:
 
-This is both a CLI tool and GitHub Action that will read the details from a GitHub Action's [`action.yml`](./action.yml) file. Configuration can be provided through a [`.ghadocs.json`](./.ghadocs.json) file stored in the root directory of the Action's repository, via the command line when using the CLI, or through the `with:` section of this Action.
+```markdown
+<!-- start inputs -->
+<!-- end inputs -->
+```
 
-**_HOW_** 📝 This tool uses markdown comments like this `<!-- start section --><!-- stop section -->` as delimiting tokens within your README.md file to determine where to place the generated content. You can find an example README template with all fields filled-in in the [`README.example.md`](./README.example.md) file.\*\*\*
+Run the generator, and content between these markers is automatically updated from your `action.yml`. See [`README.example.md`](./README.example.md) for a complete template.
+
+**Works as both CLI and GitHub Action** - configure via [`.ghadocs.json`](./.ghadocs.json), command line args, or the Action's `with:` section.
 
 ## CLI Usage
 
@@ -120,6 +154,22 @@ This configuration will automatically regenerate your README whenever `action.ym
 ```
 
 <!-- start contents -->
+
+## Table of Contents
+
+- [Quick Start](#quick-start)
+- [Features](#features)
+- [How It Works](#how-it-works)
+- [CLI Usage](#cli-usage)
+  - [Stand Alone Usage - if you have a Docker Action](#stand-alone-usage-if-you-have-a-docker-action)
+  - [Install with Yarn or NPM as a dev dependency](#install-with-yarn-or-npm-as-a-dev-dependency)
+  - [Add a script to your project file](#add-a-script-to-your-project-file)
+  - [Using as a Pre-commit Hook](#using-as-a-pre-commit-hook)
+- [Configuration](#configuration)
+  - [Example `.ghadocs.json` with all possible values](#example-ghadocsjson-with-all-possible-values)
+- [Usage](#usage)
+- [Inputs](#inputs)
+
 <!-- end contents -->
 
 ## Usage
@@ -127,7 +177,7 @@ This configuration will automatically regenerate your README whenever `action.ym
 <!-- start usage -->
 
 ```yaml
-- uses: bitflight-devops/github-action-readme-generator@v1.8.9
+- uses: bitflight-devops/github-action-readme-generator@v1.9.0
   with:
     # Description: The absolute or relative path to the `action.yml` file to read in
     # from.
@@ -260,3 +310,13 @@ This configuration will automatically regenerate your README whenever `action.ym
 
 <!-- start [.github/ghadocs/examples/] -->
 <!-- end [.github/ghadocs/examples/] -->
+
+---
+
+<div align="center">
+
+<img src=".github/bitflight-devops.png" alt="Bitflight DevOps" width="400" />
+
+**Built by [Bitflight DevOps](https://github.com/bitflight-devops)**
+
+</div>

package/action.yml

@@ -1,7 +1,7 @@
 ---
 name: GitHub Action's Readme Generator
 author: Jamie Nelson <jamie@bitflight.io>
-description: 📓 Effortlessly sync action.yml to README.md. Auto-generates inputs, outputs & usage docs, ensuring docs match code.
+description: 📓 The docs generator for GitHub Actions. Auto-syncs action.yml → README.md with 8 sections including inputs, outputs, usage, badges & branding. Sensible defaults, highly configurable.
 
 branding:
   icon: book-open