mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-09 18:43:34 -05:00
Merge pull request #280 from powerOFMAX/table-of-contents
Add Table of Contents to README
This commit is contained in:
commit
09f94929ef
1 changed files with 14 additions and 0 deletions
14
README.md
14
README.md
|
@ -8,6 +8,20 @@ The end goal of this tool:
|
|||
- Build guidelines for code layout and format
|
||||
- Automate the process to help streamline code reviews
|
||||
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [How it works](#how-it-works)
|
||||
- [Supported linters](#supported-linters)
|
||||
- [Usage](#how-to-use)
|
||||
- [Environment variables](#environment-variables)
|
||||
- [Disable rules](#disabling-rules)
|
||||
- [Docker Hub](#docker-hub)
|
||||
- [Run Super-Linter locally](#running-super-linter-locally-troubleshootingdebuggingenhancements)
|
||||
- [CI / CT/ CD](#cictcd)
|
||||
- [Limitations](#limitations)
|
||||
- [Contributing](#how-to-contribute)
|
||||
|
||||
## How it Works
|
||||
|
||||
The super-linter finds issues and reports them to the console output. Fixes are suggested in the console output but not automatically fixed, and a status check will show up as failed on the pull request.
|
||||
|
|
Loading…
Reference in a new issue