Skip to content

Commit 434c5a7

Browse files
authored
Add GIF presentation & fix Table of contents (#3910)
* Add presentation & fix Table of contents * Build
1 parent 9e8becc commit 434c5a7

File tree

2 files changed

+85
-87
lines changed

2 files changed

+85
-87
lines changed

README.md

+83-85
Original file line numberDiff line numberDiff line change
@@ -52,97 +52,95 @@ MegaLinter has **native integrations** with many of the major CI/CD tools of the
5252

5353
<!-- welcome-phrase-end -->
5454

55+
![MegaLinter Presentation GIF](https://github.com/oxsecurity/megalinter/blob/main/docs/assets/images/MegaLinter-banner-Medium.gif?raw=true)
56+
5557
<!-- online-doc-start -->
56-
See [**Online Documentation Web Site which has a much easier user navigation than this README**](https://megalinter.io/)
58+
Before going below, see [**Online Documentation Web Site which has a much easier user navigation than this README**](https://megalinter.io/)
5759
<!-- online-doc-end -->
5860

59-
[![_**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)
60-
6161
<!-- table-of-contents-start -->
6262
## Table of Contents
6363

64-
- [MegaLinter, by](#megalinter-by-)
65-
- [Table of Contents](#table-of-contents)
66-
- [Why MegaLinter](#why-megalinter)
67-
- [Quick Start](#quick-start)
68-
- [Supported Linters](#supported-linters)
69-
- [Languages](#languages)
70-
- [Formats](#formats)
71-
- [Tooling formats](#tooling-formats)
72-
- [Other](#other)
73-
- [Installation](#installation)
74-
- [Assisted installation](#assisted-installation)
75-
- [Which version to use ?](#which-version-to-use-)
76-
- [GitHub Action](#github-action)
77-
- [GitLab CI](#gitlab-ci)
78-
- [Manual Setup](#manual-setup)
79-
- [Using R2Devops](#using-r2devops)
80-
- [Azure Pipelines](#azure-pipelines)
81-
- [Bitbucket Pipelines](#bitbucket-pipelines)
82-
- [Jenkins](#jenkins)
83-
- [Concourse](#concourse)
84-
- [Pipeline step](#pipeline-step)
85-
- [Use it as reusable task](#use-it-as-reusable-task)
86-
- [Drone CI](#drone-ci)
87-
- [(Optional) Adjusting trigger rules](#optional-adjusting-trigger-rules)
88-
- [Docker container](#docker-container)
89-
- [Run MegaLinter locally](#run-megalinter-locally)
90-
- [Configuration](#configuration)
91-
- [.mega-linter.yml file](#mega-linteryml-file)
92-
- [Common variables](#common-variables)
93-
- [Activation and deactivation](#activation-and-deactivation)
94-
- [Filter linted files](#filter-linted-files)
95-
- [Apply fixes](#apply-fixes)
96-
- [Apply fixes issues](#apply-fixes-issues)
97-
- [Notes](#notes)
98-
- [Linter specific variables](#linter-specific-variables)
99-
- [Pre-commands](#pre-commands)
100-
- [Post-commands](#post-commands)
101-
- [Environment variables security](#environment-variables-security)
102-
- [Secured env variables](#secured-env-variables)
103-
- [Secured configuration examples](#secured-configuration-examples)
104-
- [Default secured variables](#default-secured-variables)
105-
- [Unhide variables for linters](#unhide-variables-for-linters)
106-
- [CLI lint mode](#cli-lint-mode)
107-
- [Reporters](#reporters)
108-
- [Flavors](#flavors)
109-
- [Badge](#badge)
110-
- [Markdown](#markdown)
111-
- [reStructuredText](#restructuredtext)
112-
- [Plugins](#plugins)
113-
- [External Plugins Catalog](#external-plugins-catalog)
114-
- [Use external plugins](#use-external-plugins)
115-
- [Example](#example)
116-
- [Create your own plugin](#create-your-own-plugin)
117-
- [Limitations](#limitations)
118-
- [They talk about MegaLinter](#they-talk-about-megalinter)
119-
- [English articles](#english-articles)
120-
- [French articles](#french-articles)
121-
- [Videos](#videos)
122-
- [Web Sites](#web-sites)
123-
- [Linters](#linters)
124-
- [Frequently Asked Questions](#frequently-asked-questions)
125-
- [How to contribute](#how-to-contribute)
126-
- [Special thanks](#special-thanks)
127-
- [Maintainers](#maintainers)
128-
- [Contributors](#contributors)
129-
- [Open-source teams](#open-source-teams)
130-
- [Super-Linter team](#super-linter-team)
131-
- [License](#license)
132-
- [MegaLinter vs Super-Linter](#megalinter-vs-super-linter)
133-
- [Security](#security)
134-
- [Performances](#performances)
135-
- [More languages and formats linted](#more-languages-and-formats-linted)
136-
- [Automatically apply formatting and fixes](#automatically-apply-formatting-and-fixes)
137-
- [Run locally](#run-locally)
138-
- [Reports](#reports)
139-
- [Capabilities](#capabilities)
140-
- [Additional Reporters](#additional-reporters)
141-
- [Enhanced Configuration](#enhanced-configuration)
142-
- [Enhanced Documentation](#enhanced-documentation)
143-
- [Plugins management](#plugins-management)
144-
- [Simplify architecture and evolutive maintenance](#simplify-architecture-and-evolutive-maintenance)
145-
- [Improve robustness \& stability](#improve-robustness--stability)
64+
- [Why MegaLinter](#why-megalinter)
65+
- [Quick Start](#quick-start)
66+
- [Supported Linters](#supported-linters)
67+
- [Languages](#languages)
68+
- [Formats](#formats)
69+
- [Tooling formats](#tooling-formats)
70+
- [Other](#other)
71+
- [Installation](#installation)
72+
- [Assisted installation](#assisted-installation)
73+
- [Which version to use ?](#which-version-to-use-)
74+
- [GitHub Action](#github-action)
75+
- [GitLab CI](#gitlab-ci)
76+
- [Manual Setup](#manual-setup)
77+
- [Using R2Devops](#using-r2devops)
78+
- [Azure Pipelines](#azure-pipelines)
79+
- [Bitbucket Pipelines](#bitbucket-pipelines)
80+
- [Jenkins](#jenkins)
81+
- [Concourse](#concourse)
82+
- [Pipeline step](#pipeline-step)
83+
- [Use it as reusable task](#use-it-as-reusable-task)
84+
- [Drone CI](#drone-ci)
85+
- [(Optional) Adjusting trigger rules](#optional-adjusting-trigger-rules)
86+
- [Docker container](#docker-container)
87+
- [Run MegaLinter locally](#run-megalinter-locally)
88+
- [Configuration](#configuration)
89+
- [.mega-linter.yml file](#mega-linteryml-file)
90+
- [Common variables](#common-variables)
91+
- [Activation and deactivation](#activation-and-deactivation)
92+
- [Filter linted files](#filter-linted-files)
93+
- [Apply fixes](#apply-fixes)
94+
- [Apply fixes issues](#apply-fixes-issues)
95+
- [Notes](#notes)
96+
- [Linter specific variables](#linter-specific-variables)
97+
- [Pre-commands](#pre-commands)
98+
- [Post-commands](#post-commands)
99+
- [Environment variables security](#environment-variables-security)
100+
- [Secured env variables](#secured-env-variables)
101+
- [Secured configuration examples](#secured-configuration-examples)
102+
- [Default secured variables](#default-secured-variables)
103+
- [Unhide variables for linters](#unhide-variables-for-linters)
104+
- [CLI lint mode](#cli-lint-mode)
105+
- [Reporters](#reporters)
106+
- [Flavors](#flavors)
107+
- [Badge](#badge)
108+
- [Markdown](#markdown)
109+
- [reStructuredText](#restructuredtext)
110+
- [Plugins](#plugins)
111+
- [External Plugins Catalog](#external-plugins-catalog)
112+
- [Use external plugins](#use-external-plugins)
113+
- [Example](#example)
114+
- [Create your own plugin](#create-your-own-plugin)
115+
- [Limitations](#limitations)
116+
- [They talk about MegaLinter](#they-talk-about-megalinter)
117+
- [English articles](#english-articles)
118+
- [French articles](#french-articles)
119+
- [Videos](#videos)
120+
- [Web Sites](#web-sites)
121+
- [Linters](#linters)
122+
- [Frequently Asked Questions](#frequently-asked-questions)
123+
- [How to contribute](#how-to-contribute)
124+
- [Special thanks](#special-thanks)
125+
- [Maintainers](#maintainers)
126+
- [Contributors](#contributors)
127+
- [Open-source teams](#open-source-teams)
128+
- [Super-Linter team](#super-linter-team)
129+
- [License](#license)
130+
- [MegaLinter vs Super-Linter](#megalinter-vs-super-linter)
131+
- [Security](#security)
132+
- [Performances](#performances)
133+
- [More languages and formats linted](#more-languages-and-formats-linted)
134+
- [Automatically apply formatting and fixes](#automatically-apply-formatting-and-fixes)
135+
- [Run locally](#run-locally)
136+
- [Reports](#reports)
137+
- [Capabilities](#capabilities)
138+
- [Additional Reporters](#additional-reporters)
139+
- [Enhanced Configuration](#enhanced-configuration)
140+
- [Enhanced Documentation](#enhanced-documentation)
141+
- [Plugins management](#plugins-management)
142+
- [Simplify architecture and evolutive maintenance](#simplify-architecture-and-evolutive-maintenance)
143+
- [Improve robustness \& stability](#improve-robustness--stability)
146144
<!-- table-of-contents-end -->
147145

148146
## Why MegaLinter

docs/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ MegaLinter has **native integrations** with many of the major CI/CD tools of the
4646

4747
<!-- welcome-phrase-end -->
4848

49+
![MegaLinter Presentation GIF](https://github.com/oxsecurity/megalinter/blob/main/docs/assets/images/MegaLinter-banner-Medium.gif?raw=true)
50+
4951
<!-- online-doc-start -->
5052

5153
<!-- online-doc-end -->
5254

53-
[![_**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)
54-
5555
<!-- table-of-contents-start -->
5656

5757
<!-- table-of-contents-end -->

0 commit comments

Comments
 (0)