Add GIF presentation & fix Table of contents (#3910)

* Add presentation & fix Table of contents * Build
oxsecurity · Aug 19, 2024 · 434c5a7 · 434c5a7
1 parent 9e8becc
commit 434c5a7
Show file tree

Hide file tree

Showing 2 changed files with 85 additions and 87 deletions.
diff --git a/README.md b/README.md
@@ -52,97 +52,95 @@ MegaLinter has **native integrations** with many of the major CI/CD tools of the
 
 <!-- welcome-phrase-end -->
 
+![MegaLinter Presentation GIF](https://github.com/oxsecurity/megalinter/blob/main/docs/assets/images/MegaLinter-banner-Medium.gif?raw=true)
+
 <!-- online-doc-start -->
-See [**Online Documentation Web Site which has a much easier user navigation than this README**](https://megalinter.io/)
+Before going below, see [**Online Documentation Web Site which has a much easier user navigation than this README**](https://megalinter.io/)
 <!-- online-doc-end -->
 
-[![_**See Article on Medium**_](https://github.com/oxsecurity/megalinter/blob/main/docs/assets/images/megalinter-article.jpg?raw=true)](https://nicolas.vuillamy.fr/improve-uniformize-and-secure-your-code-base-with-megalinter-62ebab422c1)
-
 <!-- table-of-contents-start -->
 ## Table of Contents
 
-- [MegaLinter, by](#megalinter-by-)
-  - [Table of Contents](#table-of-contents)
-  - [Why MegaLinter](#why-megalinter)
-  - [Quick Start](#quick-start)
-  - [Supported Linters](#supported-linters)
-    - [Languages](#languages)
-    - [Formats](#formats)
-    - [Tooling formats](#tooling-formats)
-    - [Other](#other)
-  - [Installation](#installation)
-    - [Assisted installation](#assisted-installation)
-    - [Which version to use ?](#which-version-to-use-)
-    - [GitHub Action](#github-action)
-    - [GitLab CI](#gitlab-ci)
-      - [Manual Setup](#manual-setup)
-      - [Using R2Devops](#using-r2devops)
-    - [Azure Pipelines](#azure-pipelines)
-    - [Bitbucket Pipelines](#bitbucket-pipelines)
-    - [Jenkins](#jenkins)
-    - [Concourse](#concourse)
-      - [Pipeline step](#pipeline-step)
-      - [Use it as reusable task](#use-it-as-reusable-task)
-    - [Drone CI](#drone-ci)
-      - [(Optional) Adjusting trigger rules](#optional-adjusting-trigger-rules)
-    - [Docker container](#docker-container)
-    - [Run MegaLinter locally](#run-megalinter-locally)
-  - [Configuration](#configuration)
-    - [.mega-linter.yml file](#mega-linteryml-file)
-    - [Common variables](#common-variables)
-    - [Activation and deactivation](#activation-and-deactivation)
-    - [Filter linted files](#filter-linted-files)
-    - [Apply fixes](#apply-fixes)
-      - [Apply fixes issues](#apply-fixes-issues)
-      - [Notes](#notes)
-    - [Linter specific variables](#linter-specific-variables)
-    - [Pre-commands](#pre-commands)
-    - [Post-commands](#post-commands)
-    - [Environment variables security](#environment-variables-security)
-      - [Secured env variables](#secured-env-variables)
-      - [Secured configuration examples](#secured-configuration-examples)
-      - [Default secured variables](#default-secured-variables)
-      - [Unhide variables for linters](#unhide-variables-for-linters)
-    - [CLI lint mode](#cli-lint-mode)
-  - [Reporters](#reporters)
-  - [Flavors](#flavors)
-  - [Badge](#badge)
-    - [Markdown](#markdown)
-    - [reStructuredText](#restructuredtext)
-  - [Plugins](#plugins)
-    - [External Plugins Catalog](#external-plugins-catalog)
-    - [Use external plugins](#use-external-plugins)
-      - [Example](#example)
-    - [Create your own plugin](#create-your-own-plugin)
-      - [Limitations](#limitations)
-  - [They talk about MegaLinter](#they-talk-about-megalinter)
-    - [English articles](#english-articles)
-    - [French articles](#french-articles)
-    - [Videos](#videos)
-    - [Web Sites](#web-sites)
-    - [Linters](#linters)
-  - [Frequently Asked Questions](#frequently-asked-questions)
-  - [How to contribute](#how-to-contribute)
-  - [Special thanks](#special-thanks)
-    - [Maintainers](#maintainers)
-    - [Contributors](#contributors)
-    - [Open-source teams](#open-source-teams)
-    - [Super-Linter team](#super-linter-team)
-  - [License](#license)
-  - [MegaLinter vs Super-Linter](#megalinter-vs-super-linter)
-    - [Security](#security)
-    - [Performances](#performances)
-    - [More languages and formats linted](#more-languages-and-formats-linted)
-    - [Automatically apply formatting and fixes](#automatically-apply-formatting-and-fixes)
-    - [Run locally](#run-locally)
-    - [Reports](#reports)
-      - [Capabilities](#capabilities)
-      - [Additional Reporters](#additional-reporters)
-    - [Enhanced Configuration](#enhanced-configuration)
-    - [Enhanced Documentation](#enhanced-documentation)
-    - [Plugins management](#plugins-management)
-    - [Simplify architecture and evolutive maintenance](#simplify-architecture-and-evolutive-maintenance)
-    - [Improve robustness \& stability](#improve-robustness--stability)
+- [Why MegaLinter](#why-megalinter)
+- [Quick Start](#quick-start)
+- [Supported Linters](#supported-linters)
+  - [Languages](#languages)
+  - [Formats](#formats)
+  - [Tooling formats](#tooling-formats)
+  - [Other](#other)
+- [Installation](#installation)
+  - [Assisted installation](#assisted-installation)
+  - [Which version to use ?](#which-version-to-use-)
+  - [GitHub Action](#github-action)
+  - [GitLab CI](#gitlab-ci)
+    - [Manual Setup](#manual-setup)
+    - [Using R2Devops](#using-r2devops)
+  - [Azure Pipelines](#azure-pipelines)
+  - [Bitbucket Pipelines](#bitbucket-pipelines)
+  - [Jenkins](#jenkins)
+  - [Concourse](#concourse)
+    - [Pipeline step](#pipeline-step)
+    - [Use it as reusable task](#use-it-as-reusable-task)
+  - [Drone CI](#drone-ci)
+    - [(Optional) Adjusting trigger rules](#optional-adjusting-trigger-rules)
+  - [Docker container](#docker-container)
+  - [Run MegaLinter locally](#run-megalinter-locally)
+- [Configuration](#configuration)
+  - [.mega-linter.yml file](#mega-linteryml-file)
+  - [Common variables](#common-variables)
+  - [Activation and deactivation](#activation-and-deactivation)
+  - [Filter linted files](#filter-linted-files)
+  - [Apply fixes](#apply-fixes)
+    - [Apply fixes issues](#apply-fixes-issues)
+    - [Notes](#notes)
+  - [Linter specific variables](#linter-specific-variables)
+  - [Pre-commands](#pre-commands)
+  - [Post-commands](#post-commands)
+  - [Environment variables security](#environment-variables-security)
+    - [Secured env variables](#secured-env-variables)
+    - [Secured configuration examples](#secured-configuration-examples)
+    - [Default secured variables](#default-secured-variables)
+    - [Unhide variables for linters](#unhide-variables-for-linters)
+  - [CLI lint mode](#cli-lint-mode)
+- [Reporters](#reporters)
+- [Flavors](#flavors)
+- [Badge](#badge)
+  - [Markdown](#markdown)
+  - [reStructuredText](#restructuredtext)
+- [Plugins](#plugins)
+  - [External Plugins Catalog](#external-plugins-catalog)
+  - [Use external plugins](#use-external-plugins)
+    - [Example](#example)
+  - [Create your own plugin](#create-your-own-plugin)
+    - [Limitations](#limitations)
+- [They talk about MegaLinter](#they-talk-about-megalinter)
+  - [English articles](#english-articles)
+  - [French articles](#french-articles)
+  - [Videos](#videos)
+  - [Web Sites](#web-sites)
+  - [Linters](#linters)
+- [Frequently Asked Questions](#frequently-asked-questions)
+- [How to contribute](#how-to-contribute)
+- [Special thanks](#special-thanks)
+  - [Maintainers](#maintainers)
+  - [Contributors](#contributors)
+  - [Open-source teams](#open-source-teams)
+  - [Super-Linter team](#super-linter-team)
+- [License](#license)
+- [MegaLinter vs Super-Linter](#megalinter-vs-super-linter)
+  - [Security](#security)
+  - [Performances](#performances)
+  - [More languages and formats linted](#more-languages-and-formats-linted)
+  - [Automatically apply formatting and fixes](#automatically-apply-formatting-and-fixes)
+  - [Run locally](#run-locally)
+  - [Reports](#reports)
+    - [Capabilities](#capabilities)
+    - [Additional Reporters](#additional-reporters)
+  - [Enhanced Configuration](#enhanced-configuration)
+  - [Enhanced Documentation](#enhanced-documentation)
+  - [Plugins management](#plugins-management)
+  - [Simplify architecture and evolutive maintenance](#simplify-architecture-and-evolutive-maintenance)
+  - [Improve robustness \& stability](#improve-robustness--stability)
 <!-- table-of-contents-end -->
 
 ## Why MegaLinter

diff --git a/docs/index.md b/docs/index.md
@@ -46,12 +46,12 @@ MegaLinter has **native integrations** with many of the major CI/CD tools of the
 
 <!-- welcome-phrase-end -->
 
+![MegaLinter Presentation GIF](https://github.com/oxsecurity/megalinter/blob/main/docs/assets/images/MegaLinter-banner-Medium.gif?raw=true)
+
 <!-- online-doc-start -->
 
 <!-- online-doc-end -->
 
-[![_**See Article on Medium**_](https://github.com/oxsecurity/megalinter/blob/main/docs/assets/images/megalinter-article.jpg?raw=true)](https://nicolas.vuillamy.fr/improve-uniformize-and-secure-your-code-base-with-megalinter-62ebab422c1)
-
 <!-- table-of-contents-start -->
 
 <!-- table-of-contents-end -->