Skip to content

Commit

Permalink
Add table of contents (#270)
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkEWaite authored Dec 16, 2023
1 parent d1a4a85 commit e65ea69
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Embeddable Build Status Plugin

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Query Parameters](#query-parameters)
- [Parameter Resolver](#parameter-resolver)
- [Pipeline (DSL)](#pipeline-dsl)
- [Text variant](#text-variant)
- [Extension points for plugin developers](#extension-points-for-plugin-developers)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

This plugin provides customizable badges (similar to [shields.io](https://shields.io)) to any website.
A [text variant](#text-variant) is also available that returns the build status as text.

Expand Down Expand Up @@ -122,6 +133,7 @@ This searches in the last `10` runs for the first successful build of the `maste
Provide a link to be opened on clicking on the badge.

## Parameter Resolver

The query parameters `subject`, `status`, `color`, `animatedOverlayColor` and `link` support the usage of variables like `?subject=Build ${variable}`

Available builtin variables are:
Expand Down

0 comments on commit e65ea69

Please sign in to comment.