actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-21 21:50:59 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Fix markdown lint errors

Browse source
This commit is contained in:
Gabo 2020-06-25 10:04:02 -05:00
parent 172e29dad3
commit b8171a9bfb
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,5 +1,5 @@
# Super-Linter # Super-Linter
This repository is for the **GitHub Action** to run a **Super-Linter**. This repository is for the **GitHub Action** to run a **Super-Linter**.
It is a simple combination of various linters, written in `bash`, to help validate your source code. It is a simple combination of various linters, written in `bash`, to help validate your source code.
The end goal of this tool: The end goal of this tool:
@ -112,9 +112,9 @@ jobs:
## Environment variables ## Environment variables
The super-linter allows you to pass the following `ENV` variables to be able to trigger different functionality. The super-linter allows you to pass the following `ENV` variables to be able to trigger different functionality.
*Note:* All the `VALIDATE_[LANGUAGE]` variables behave in a specific way. *Note:* All the `VALIDATE_[LANGUAGE]` variables behave in a specific way.
If none of them are passed, then they all default to true. If none of them are passed, then they all default to true.
However if any one of the variables are set, we default to leaving any unset variable to false. However if any one of the variables are set, we default to leaving any unset variable to false.
This means that if you run the linter "out of the box", all languages will be checked. This means that if you run the linter "out of the box", all languages will be checked.
But if you wish to select specific linters, we give you full control to choose which linters are run, But if you wish to select specific linters, we give you full control to choose which linters are run,
and won't run anything unexpected. and won't run anything unexpected.
@ -186,12 +186,11 @@ Below are a list of the known limitations for the **GitHub Super-Linter**:
If you would like to help contribute to this **GitHub** Action, please see [CONTRIBUTING](https://github.com/github/super-linter/blob/master/.github/CONTRIBUTING.md) If you would like to help contribute to this **GitHub** Action, please see [CONTRIBUTING](https://github.com/github/super-linter/blob/master/.github/CONTRIBUTING.md)
### Visual Studio Code ### Visual Studio Code
You can checkout this repository using [Container Remote Development](https://code.visualstudio.com/docs/remote/containers), and debug the linter using the `Test Linter` task. You can checkout this repository using [Container Remote Development](https://code.visualstudio.com/docs/remote/containers), and debug the linter using the `Test Linter` task.
![Example](https://user-images.githubusercontent.com/15258962/85165778-2d2ce700-b21b-11ea-803e-3f6709d8e609.gif) ![Example](https://user-images.githubusercontent.com/15258962/85165778-2d2ce700-b21b-11ea-803e-3f6709d8e609.gif)
We will also support [Github Codespaces](https://github.com/features/codespaces/) once it becomes available We will also support [Github Codespaces](https://github.com/features/codespaces/) once it becomes available
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
### License ### License