From aa390de227c237b64fb6281626c947a287fb9923 Mon Sep 17 00:00:00 2001 From: Marco Ferrari Date: Thu, 4 Jul 2024 22:23:47 +0200 Subject: [PATCH] docs: fix linting errors (#5839) Close #5838 Close #5837 --- README.md | 6 +++--- docs/run-linter-locally.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bdf9ad2f..788bc4ba 100644 --- a/README.md +++ b/README.md @@ -158,9 +158,9 @@ To run super-linter as a GitHub Action, you do the following: For more information about upgrading super-linter to a new major version, see the [upgrade guide](docs/upgrade-guide.md). -## Add Super-Linter badge in your repository README +## Add Super-Linter badge in your repository readme -You can show Super-Linter status with a badge in your repository README: +You can show Super-Linter status with a badge in your repository readme: Example: @@ -268,7 +268,7 @@ You can configure super-linter using the following environment variables: | **VALIDATE_CLANG_FORMAT** | `true` | Flag to enable or disable the linting process of the C++/C language with clang-format. | | **VALIDATE_CLOJURE** | `true` | Flag to enable or disable the linting process of the Clojure language. | | **VALIDATE_CLOUDFORMATION** | `true` | Flag to enable or disable the linting process of the AWS Cloud Formation language. | -| **VALIDATE_COFFEESCRIPT** | `true` | Flag to enable or disable the linting process of the Coffeescript language. | +| **VALIDATE_COFFEESCRIPT** | `true` | Flag to enable or disable the linting process of the CoffeeScript language. | | **VALIDATE_CSHARP** | `true` | Flag to enable or disable the linting process of the C# language. | | **VALIDATE_CSS** | `true` | Flag to enable or disable the linting process of the CSS language. | | **VALIDATE_DART** | `true` | Flag to enable or disable the linting process of the Dart language. | diff --git a/docs/run-linter-locally.md b/docs/run-linter-locally.md index f1aafa69..8818efc6 100644 --- a/docs/run-linter-locally.md +++ b/docs/run-linter-locally.md @@ -25,7 +25,7 @@ Notes: - To run against a single file you can use: `docker run -e RUN_LOCAL=true -e USE_FIND_ALGORITHM=true -v /path/to/local/codebase/file:/tmp/lint/file ghcr.io/super-linter/super-linter` - You need to pass the `RUN_LOCAL` option to bypass some of the GitHub Actions checks, as well as the mapping of your local codebase to `/tmp/lint`. - If you want to override the `/tmp/lint` folder, you can set the `DEFAULT_WORKSPACE` environment variable to point to the folder you'd prefer to scan. -- You can add as many configuration options as needed. Configuration options are documented in the [README](../README.md#configure-super-linter). +- You can add as many configuration options as needed. Configuration options are documented in the [readme](../README.md#configure-super-linter). ### GitLab