@@ -178,6 +178,35 @@ onto the base image `davidanson/markdownlint-cli2`.
178178**Note**: This container image exists for convenience and is not an endorsement
179179of the rules within.
180180
181+ # ## Output Formatters
182+
183+ In addition to (or instead of) the default behavior of writing a list of all
184+ issues to the standard error (`stderr`) device, custom output formatters can be
185+ configured to produce a variety of outputs like :
186+
187+ - [List of issues (default)][formatter-default]
188+ - [List of issues with color and links][formatter-pretty]
189+ - [GitLab Code Quality report file][formatter-codequality]
190+ - [JSON file][formatter-json]
191+ - [JUnit XML file][formatter-junit]
192+ - [Static Analysis Results Interchange Format/SARIF file][formatter-sarif]
193+ - [Summary of issues found][formatter-summarize]
194+ - [Flexible string template][formatter-template] supporting :
195+ - Azure Pipelines Task command LogIssue format
196+ - GitHub Actions workflow commands format
197+
198+ [formatter-default] : ./formatter-default/README.md
199+ [formatter-codequality] : ./formatter-codequality/README.md
200+ [formatter-json] : ./formatter-json/README.md
201+ [formatter-junit] : ./formatter-junit/README.md
202+ [formatter-pretty] : ./formatter-pretty/README.md
203+ [formatter-sarif] : ./formatter-sarif/README.md
204+ [formatter-summarize] : ./formatter-summarize/README.md
205+ [formatter-template] : ./formatter-template/README.md
206+
207+ For more information, refer to the documentation for the `outputFormatters`
208+ parameter below.
209+
181210# ## Exit Codes
182211
183212- `0` : Linting was successful and there were no errors (there may be warnings)
0 commit comments