From 448bfcf55b2e163ce2cf9829ed5940e2ba8f05a6 Mon Sep 17 00:00:00 2001 From: nvuillam Date: Sun, 6 Sep 2026 08:25:17 +0200 Subject: [PATCH 1/4] [doc] Reorganize documentation navigation: 24 root menus -> 9 The mkdocs/Zensical navigation had grown to 24 root entries, making the sidebar hard to scan. Pages are now grouped into a handful of sections without moving or renaming any file, so all megalinter.io URLs are kept. New root structure: - Home - Quick Start - Getting Started (which version, assisted install, vs Super-Linter, FAQ) - Installation (Coding Agents / CI-CD Platforms / Local usage sub-menus) - Configuration (config-* pages + Flavors + Linter Plugins) - Linters (all supported, list of linters, removed, by category) - Reporting (Reporters + Observability + LLM Advisor) - About (articles, used by, badge, thanks, sponsoring, contribute, license, changelog) - Try OX Security ASPM build.py emits the generated flavors nav block one level deeper, since Flavors is now nested under Configuration. The language / format / tooling_format / other generated blocks keep their previous depth and are unchanged; all four regenerate byte-identically. Verified with a full `zensical build --clean`: 403 pages, no new warning. --- .automation/build.py | 2 +- CHANGELOG.md | 4 + mkdocs.yml | 210 ++++++++++++++++++++++--------------------- 3 files changed, 113 insertions(+), 103 deletions(-) diff --git a/.automation/build.py b/.automation/build.py index bc7ecea5aa5..cc7be38b00a 100644 --- a/.automation/build.py +++ b/.automation/build.py @@ -2620,7 +2620,7 @@ def update_mkdocs_and_workflow_yml_with_flavors(): mkdocs_yml = [] gha_workflow_yml = [" flavor:", " ["] for flavor_id, _flavor_info in megalinter.flavor_factory.get_all_flavors().items(): - mkdocs_yml += [f' - "{flavor_id}": "flavors/{flavor_id}.md"'] + mkdocs_yml += [f' - "{flavor_id}": "flavors/{flavor_id}.md"'] gha_workflow_yml += [f' "{flavor_id}",'] gha_workflow_yml += [" ]"] # Update mkdocs.yml file diff --git a/CHANGELOG.md b/CHANGELOG.md index d69f086324a..ed9a5a13006 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -33,6 +33,10 @@ Note: Can be used with `oxsecurity/megalinter@beta` in your GitHub Action mega-l - Flavors - Doc + - The [documentation](https://megalinter.io) menu is reorganized from **24 root entries down to 9**: pages are now grouped under **Getting Started**, **Installation**, **Configuration**, **Linters**, **Reporting** and **About**, so the sidebar can be scanned at a glance + - **Installation** groups the CI/CD platforms, the coding agents and the local usage pages in three sub-menus + - **Flavors** and **Linter Plugins** moved under **Configuration**, **Observability** and **LLM Advisor** under **Reporting** + - All documentation **URLs are unchanged**: only the menu structure was updated - mega-linter-runner diff --git a/mkdocs.yml b/mkdocs.yml index 12a41a68bd5..064ca0b17e4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -81,34 +81,67 @@ extra: nav: - "Home": "index.md" - "Quick Start": "quick-start.md" - - "Coding Agents": "coding-agents.md" + - "Getting Started": + - "Which version to use ?": "install-version.md" + - "Assisted Installation": "install-assisted.md" + - "MegaLinter vs Super-Linter": "mega-linter-vs-super-linter.md" + - "FAQ": "frequently-asked-questions.md" - "Installation": - - "Coding Agents (Skills)": "install-agent-skills.md" - - "Coding Agents (Plugins)": "agent-plugins.md" - - "Assisted Installation": "install-assisted.md" - - "Which version to use ?": "install-version.md" - - "GitHub Actions": "install-github.md" - - "Gitlab CI": "install-gitlab.md" - - "Azure Pipelines": "install-azure.md" - - "Bitbucket Pipelines": "install-bitbucket.md" - - "Jenkins": "install-jenkins.md" - - "Concourse CI": "install-concourse.md" - - "Drone CI": "install-drone.md" - - "Docker (CLI)": "install-docker.md" - - "Run locally": "install-locally.md" - - "Configuration": - - ".mega-linter.yml file": "config-file.md" - - "Common Variables": "config-variables.md" - - "Activation / Deactivation": "config-activation.md" - - "Filtering files": "config-filtering.md" - - "Apply fixes": "config-apply-fixes.md" - - "Linter scopes variables": "config-linters.md" - - "Pre-commands": "config-precommands.md" - - "Post-commands": "config-postcommands.md" - - "ENV variables security": "config-variables-security.md" - - "CLI lint mode": "config-cli-lint-mode.md" + - "Coding Agents": + - "Coding Agents": "coding-agents.md" + - "Agent Skills": "install-agent-skills.md" + - "Agent Plugins": "agent-plugins.md" + - "CI/CD Platforms": + - "GitHub Actions": "install-github.md" + - "Gitlab CI": "install-gitlab.md" + - "Azure Pipelines": "install-azure.md" + - "Bitbucket Pipelines": "install-bitbucket.md" + - "Jenkins": "install-jenkins.md" + - "Concourse CI": "install-concourse.md" + - "Drone CI": "install-drone.md" + - "Local usage": + - "Docker (CLI)": "install-docker.md" + - "Run locally": "install-locally.md" + - "mega-linter-runner": "mega-linter-runner.md" + - "Configuration": + - ".mega-linter.yml file": "config-file.md" + - "Common Variables": "config-variables.md" + - "Activation / Deactivation": "config-activation.md" + - "Filtering files": "config-filtering.md" + - "Apply fixes": "config-apply-fixes.md" + - "Linter scopes variables": "config-linters.md" + - "Pre-commands": "config-precommands.md" + - "Post-commands": "config-postcommands.md" + - "ENV variables security": "config-variables-security.md" + - "CLI lint mode": "config-cli-lint-mode.md" + - "Flavors": + - "All flavors": "flavors.md" + - "Custom flavors": "custom-flavors.md" + # flavors-start + - "c_cpp": "flavors/c_cpp.md" + - "ci_light": "flavors/ci_light.md" + - "cupcake": "flavors/cupcake.md" + - "documentation": "flavors/documentation.md" + - "dotnet": "flavors/dotnet.md" + - "dotnetweb": "flavors/dotnetweb.md" + - "formatters": "flavors/formatters.md" + - "go": "flavors/go.md" + - "java": "flavors/java.md" + - "javascript": "flavors/javascript.md" + - "php": "flavors/php.md" + - "python": "flavors/python.md" + - "ruby": "flavors/ruby.md" + - "rust": "flavors/rust.md" + - "salesforce": "flavors/salesforce.md" + - "security": "flavors/security.md" + - "swift": "flavors/swift.md" + - "terraform": "flavors/terraform.md" +# flavors-end + - "Flavors statistics": "flavors-stats.md" + - "Linter Plugins": "plugins.md" - "Linters": - "All supported linters": "supported-linters.md" + - "List of linters": "all_linters.md" - "Removed linters": "removed-linters.md" - "Languages linters": - "All language linters": "./supported-linters/#languages" @@ -375,81 +408,54 @@ nav: - "lychee": "descriptors/spell_lychee.md" - "codespell": "descriptors/spell_codespell.md" # other-end - - "Observability": - - "Observability home": "observability.md" - - "Grafana": "observability/grafana.md" - - "Datadog": "observability/datadog.md" - - "Elastic": "observability/elastic.md" - - "New Relic": "observability/newrelic.md" - - "Reporters": - - "All reporters": "reporters.md" - - "Text files": "reporters/TextReporter.md" - - "GitHub Pull Request comments": "reporters/GitHubCommentReporter.md" - - "Gitlab Merge Request comments": "reporters/GitlabCommentReporter.md" - - "Azure Pull Request comments": "reporters/AzureCommentReporter.md" - - "Bitbucket Pull Request comments": "reporters/BitbucketCommentReporter.md" - - "API / Observability": "reporters/ApiReporter.md" - - "GitHub Status": "reporters/GitHubStatusReporter.md" - - "SARIF Reporter": "reporters/SarifReporter.md" - - "Updated sources": "reporters/UpdatedSourcesReporter.md" - - "E-mail": "reporters/EmailReporter.md" - - "File.io": "reporters/FileIoReporter.md" - - "IDE Configuration": "reporters/ConfigReporter.md" - - "TAP files": "reporters/TapReporter.md" - - "Console": "reporters/ConsoleReporter.md" - - "JSON": "reporters/JsonReporter.md" - - "Markdown Summary": "reporters/MarkdownSummaryReporter.md" - - "LLM Advisor": - - "LLM Advisor": "llm-advisor.md" - - "LLM Providers": - - "All LLM providers": "llm-providers.md" - - "Anthropic": "llm-provider/llm_provider_anthropic.md" - - "DeepSeek": "llm-provider/llm_provider_deepseek.md" - - "Google GenAI": "llm-provider/llm_provider_google_genai.md" - - "MistralAI": "llm-provider/llm_provider_mistralai.md" - - "OpenAI": "llm-provider/llm_provider_openai.md" - - "OrcaRouter": "llm-provider/llm_provider_orcarouter.md" - - "Ollama": "llm-provider/llm_provider_ollama.md" - - "Hugging Face": "llm-provider/llm_provider_huggingface.md" - - "Flavors": - - "All flavors": "flavors.md" - - "Custom flavors": "custom-flavors.md" - # flavors-start - - "c_cpp": "flavors/c_cpp.md" - - "ci_light": "flavors/ci_light.md" - - "cupcake": "flavors/cupcake.md" - - "documentation": "flavors/documentation.md" - - "dotnet": "flavors/dotnet.md" - - "dotnetweb": "flavors/dotnetweb.md" - - "formatters": "flavors/formatters.md" - - "go": "flavors/go.md" - - "java": "flavors/java.md" - - "javascript": "flavors/javascript.md" - - "php": "flavors/php.md" - - "python": "flavors/python.md" - - "ruby": "flavors/ruby.md" - - "rust": "flavors/rust.md" - - "salesforce": "flavors/salesforce.md" - - "security": "flavors/security.md" - - "swift": "flavors/swift.md" - - "terraform": "flavors/terraform.md" -# flavors-end - - "Flavors statistics": "flavors-stats.md" - - "Run locally": "mega-linter-runner.md" - - "They talk about MegaLinter": "articles.md" - - "They use MegaLinter": "used-by-stats.md" - - "List of linters": "all_linters.md" - - "Linter Plugins": "plugins.md" - - "Special thanks": "special-thanks.md" - - "Sponsoring": 'sponsor.md' - - "Badge": "badge.md" - - "MegaLinter vs Super-Linter": "mega-linter-vs-super-linter.md" - - "FAQ": "frequently-asked-questions.md" - - "Contribute": - - "How-to Contribute": "how-to-contribute.md" - - "Contributing Guide": "contributing.md" - - "License": - - "AGPL V3 License": "license.md" - - "License explanations": "license-explanations.md" - - "Changelog": "CHANGELOG.md" + - "Reporting": + - "Reporters": + - "All reporters": "reporters.md" + - "Text files": "reporters/TextReporter.md" + - "GitHub Pull Request comments": "reporters/GitHubCommentReporter.md" + - "Gitlab Merge Request comments": "reporters/GitlabCommentReporter.md" + - "Azure Pull Request comments": "reporters/AzureCommentReporter.md" + - "Bitbucket Pull Request comments": "reporters/BitbucketCommentReporter.md" + - "API / Observability": "reporters/ApiReporter.md" + - "GitHub Status": "reporters/GitHubStatusReporter.md" + - "SARIF Reporter": "reporters/SarifReporter.md" + - "Updated sources": "reporters/UpdatedSourcesReporter.md" + - "E-mail": "reporters/EmailReporter.md" + - "File.io": "reporters/FileIoReporter.md" + - "IDE Configuration": "reporters/ConfigReporter.md" + - "TAP files": "reporters/TapReporter.md" + - "Console": "reporters/ConsoleReporter.md" + - "JSON": "reporters/JsonReporter.md" + - "Markdown Summary": "reporters/MarkdownSummaryReporter.md" + - "Observability": + - "Observability home": "observability.md" + - "Grafana": "observability/grafana.md" + - "Datadog": "observability/datadog.md" + - "Elastic": "observability/elastic.md" + - "New Relic": "observability/newrelic.md" + - "LLM Advisor": + - "LLM Advisor": "llm-advisor.md" + - "LLM Providers": + - "All LLM providers": "llm-providers.md" + - "Anthropic": "llm-provider/llm_provider_anthropic.md" + - "DeepSeek": "llm-provider/llm_provider_deepseek.md" + - "Google GenAI": "llm-provider/llm_provider_google_genai.md" + - "MistralAI": "llm-provider/llm_provider_mistralai.md" + - "OpenAI": "llm-provider/llm_provider_openai.md" + - "OrcaRouter": "llm-provider/llm_provider_orcarouter.md" + - "Ollama": "llm-provider/llm_provider_ollama.md" + - "Hugging Face": "llm-provider/llm_provider_huggingface.md" + - "About": + - "They talk about MegaLinter": "articles.md" + - "They use MegaLinter": "used-by-stats.md" + - "Badge": "badge.md" + - "Special thanks": "special-thanks.md" + - "Sponsoring": "sponsor.md" + - "Contribute": + - "How-to Contribute": "how-to-contribute.md" + - "Contributing Guide": "contributing.md" + - "License": + - "AGPL V3 License": "license.md" + - "License explanations": "license-explanations.md" + - "Changelog": "CHANGELOG.md" - "Try OX Security ASPM": "https://ox.security?ref=megalinter" From e439e8cb8d2308b43d5a6f2bddf276c56115e0b6 Mon Sep 17 00:00:00 2001 From: nvuillam <17500430+nvuillam@users.noreply.github.com> Date: Sun, 6 Sep 2026 06:30:05 +0000 Subject: [PATCH 2/4] [MegaLinter] Apply linters fixes --- README.md | 4 ++-- docs/descriptors/graphql.md | 2 +- docs/index.md | 4 ++-- docs/supported-linters.md | 4 ++-- mega-linter-runner/README.md | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 60fae6691a4..59e0d05cc0e 100644 --- a/README.md +++ b/README.md @@ -424,7 +424,7 @@ All linters are integrated into the [MegaLinter Docker image](https://hub.docker | | [**CSS**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css.md) | [**stylelint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md)
[_CSS_STYLELINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | | | [**CSS**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_biome.md)
[_CSS_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | | | [**ENV**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env.md) | [**dotenv-linter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md)
[_ENV_DOTENV_LINTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md) | [**graphql-schema-linter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md)
[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md) | 🚫 [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md) | [**graphql-schema-linter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md)
[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md) | 🚫 [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | | | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_biome.md)
[_GRAPHQL_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | | | [**HTML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html.md) | [**djlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_djlint.md)
[_HTML_DJLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_djlint.md) | [![GitHub stars](https://img.shields.io/github/stars/Riverside-Healthcare/djlint?cacheSeconds=3600)](https://github.com/Riverside-Healthcare/djlint) | | | [**HTML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html.md) | [**htmlhint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md)
[_HTML_HTMLHINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) ![sarif](https://shields.io/badge/-SARIF-orange) | @@ -433,7 +433,7 @@ All linters are integrated into the [MegaLinter Docker image](https://hub.docker | | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**prettier**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md)
[_JSON_PRETTIER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | | | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**npm-package-json-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_npm_package_json_lint.md)
[_JSON_NPM_PACKAGE_JSON_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_npm_package_json_lint.md) | [![GitHub stars](https://img.shields.io/github/stars/tclindner/npm-package-json-lint?cacheSeconds=3600)](https://github.com/tclindner/npm-package-json-lint) | | | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_biome.md)
[_JSON_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**LATEX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex.md) | [**chktex**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md)
[_LATEX_CHKTEX_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md) | | +| | [**LATEX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex.md) | [**chktex**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md)
[_LATEX_CHKTEX_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md) | | | | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md) | [**markdownlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md)
[_MARKDOWN_MARKDOWNLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | | | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md) | [**markdown-table-formatter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md)
[_MARKDOWN_MARKDOWN_TABLE_FORMATTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | | | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md) | [**rumdl**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_rumdl.md)
[_MARKDOWN_RUMDL_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_rumdl.md) | [![GitHub stars](https://img.shields.io/github/stars/rvben/rumdl?cacheSeconds=3600)](https://github.com/rvben/rumdl) ![formatter](https://shields.io/badge/-format-yellow) ![sarif](https://shields.io/badge/-SARIF-orange) | diff --git a/docs/descriptors/graphql.md b/docs/descriptors/graphql.md index 713eeb546e8..b9202e576e1 100644 --- a/docs/descriptors/graphql.md +++ b/docs/descriptors/graphql.md @@ -11,7 +11,7 @@ description: graphql-schema-linter, biome are available to analyze GRAPHQL files | Linter | Additional | | ------ | ---------- | -| [**graphql-schema-linter**](graphql_graphql_schema_linter.md)
[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](graphql_graphql_schema_linter.md) | 🚫 [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| [**graphql-schema-linter**](graphql_graphql_schema_linter.md)
[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](graphql_graphql_schema_linter.md) | 🚫 [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | | [**biome**](graphql_biome.md)
[_GRAPHQL_BIOME_](graphql_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | ## Linted files diff --git a/docs/index.md b/docs/index.md index fc852d2272c..ec25efea0f8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -209,7 +209,7 @@ All linters are integrated into the [MegaLinter Docker image](https://hub.docker | | [**CSS**](descriptors/css.md) | [**stylelint**](descriptors/css_stylelint.md)
[_CSS_STYLELINT_](descriptors/css_stylelint.md) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | | | [**CSS**](descriptors/css.md) | [**biome**](descriptors/css_biome.md)
[_CSS_BIOME_](descriptors/css_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | | | [**ENV**](descriptors/env.md) | [**dotenv-linter**](descriptors/env_dotenv_linter.md)
[_ENV_DOTENV_LINTER_](descriptors/env_dotenv_linter.md) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](descriptors/graphql.md) | [**graphql-schema-linter**](descriptors/graphql_graphql_schema_linter.md)
[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](descriptors/graphql_graphql_schema_linter.md) | 🚫 [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**GRAPHQL**](descriptors/graphql.md) | [**graphql-schema-linter**](descriptors/graphql_graphql_schema_linter.md)
[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](descriptors/graphql_graphql_schema_linter.md) | 🚫 [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | | | [**GRAPHQL**](descriptors/graphql.md) | [**biome**](descriptors/graphql_biome.md)
[_GRAPHQL_BIOME_](descriptors/graphql_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | | | [**HTML**](descriptors/html.md) | [**djlint**](descriptors/html_djlint.md)
[_HTML_DJLINT_](descriptors/html_djlint.md) | [![GitHub stars](https://img.shields.io/github/stars/Riverside-Healthcare/djlint?cacheSeconds=3600)](https://github.com/Riverside-Healthcare/djlint) | | | [**HTML**](descriptors/html.md) | [**htmlhint**](descriptors/html_htmlhint.md)
[_HTML_HTMLHINT_](descriptors/html_htmlhint.md) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) ![sarif](https://shields.io/badge/-SARIF-orange) | @@ -218,7 +218,7 @@ All linters are integrated into the [MegaLinter Docker image](https://hub.docker | | [**JSON**](descriptors/json.md) | [**prettier**](descriptors/json_prettier.md)
[_JSON_PRETTIER_](descriptors/json_prettier.md) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | | | [**JSON**](descriptors/json.md) | [**npm-package-json-lint**](descriptors/json_npm_package_json_lint.md)
[_JSON_NPM_PACKAGE_JSON_LINT_](descriptors/json_npm_package_json_lint.md) | [![GitHub stars](https://img.shields.io/github/stars/tclindner/npm-package-json-lint?cacheSeconds=3600)](https://github.com/tclindner/npm-package-json-lint) | | | [**JSON**](descriptors/json.md) | [**biome**](descriptors/json_biome.md)
[_JSON_BIOME_](descriptors/json_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**LATEX**](descriptors/latex.md) | [**chktex**](descriptors/latex_chktex.md)
[_LATEX_CHKTEX_](descriptors/latex_chktex.md) | | +| | [**LATEX**](descriptors/latex.md) | [**chktex**](descriptors/latex_chktex.md)
[_LATEX_CHKTEX_](descriptors/latex_chktex.md) | | | | [**MARKDOWN**](descriptors/markdown.md) | [**markdownlint**](descriptors/markdown_markdownlint.md)
[_MARKDOWN_MARKDOWNLINT_](descriptors/markdown_markdownlint.md) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | | | [**MARKDOWN**](descriptors/markdown.md) | [**markdown-table-formatter**](descriptors/markdown_markdown_table_formatter.md)
[_MARKDOWN_MARKDOWN_TABLE_FORMATTER_](descriptors/markdown_markdown_table_formatter.md) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | | | [**MARKDOWN**](descriptors/markdown.md) | [**rumdl**](descriptors/markdown_rumdl.md)
[_MARKDOWN_RUMDL_](descriptors/markdown_rumdl.md) | [![GitHub stars](https://img.shields.io/github/stars/rvben/rumdl?cacheSeconds=3600)](https://github.com/rvben/rumdl) ![formatter](https://shields.io/badge/-format-yellow) ![sarif](https://shields.io/badge/-SARIF-orange) | diff --git a/docs/supported-linters.md b/docs/supported-linters.md index 73ee781aa71..d10024ca339 100644 --- a/docs/supported-linters.md +++ b/docs/supported-linters.md @@ -92,7 +92,7 @@ All linters are integrated into the [MegaLinter Docker image](https://hub.docker | | [**CSS**](descriptors/css.md) | [**stylelint**](descriptors/css_stylelint.md)
[_CSS_STYLELINT_](descriptors/css_stylelint.md) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | | | [**CSS**](descriptors/css.md) | [**biome**](descriptors/css_biome.md)
[_CSS_BIOME_](descriptors/css_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | | | [**ENV**](descriptors/env.md) | [**dotenv-linter**](descriptors/env_dotenv_linter.md)
[_ENV_DOTENV_LINTER_](descriptors/env_dotenv_linter.md) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](descriptors/graphql.md) | [**graphql-schema-linter**](descriptors/graphql_graphql_schema_linter.md)
[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](descriptors/graphql_graphql_schema_linter.md) | 🚫 [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**GRAPHQL**](descriptors/graphql.md) | [**graphql-schema-linter**](descriptors/graphql_graphql_schema_linter.md)
[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](descriptors/graphql_graphql_schema_linter.md) | 🚫 [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | | | [**GRAPHQL**](descriptors/graphql.md) | [**biome**](descriptors/graphql_biome.md)
[_GRAPHQL_BIOME_](descriptors/graphql_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | | | [**HTML**](descriptors/html.md) | [**djlint**](descriptors/html_djlint.md)
[_HTML_DJLINT_](descriptors/html_djlint.md) | [![GitHub stars](https://img.shields.io/github/stars/Riverside-Healthcare/djlint?cacheSeconds=3600)](https://github.com/Riverside-Healthcare/djlint) | | | [**HTML**](descriptors/html.md) | [**htmlhint**](descriptors/html_htmlhint.md)
[_HTML_HTMLHINT_](descriptors/html_htmlhint.md) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) ![sarif](https://shields.io/badge/-SARIF-orange) | @@ -101,7 +101,7 @@ All linters are integrated into the [MegaLinter Docker image](https://hub.docker | | [**JSON**](descriptors/json.md) | [**prettier**](descriptors/json_prettier.md)
[_JSON_PRETTIER_](descriptors/json_prettier.md) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | | | [**JSON**](descriptors/json.md) | [**npm-package-json-lint**](descriptors/json_npm_package_json_lint.md)
[_JSON_NPM_PACKAGE_JSON_LINT_](descriptors/json_npm_package_json_lint.md) | [![GitHub stars](https://img.shields.io/github/stars/tclindner/npm-package-json-lint?cacheSeconds=3600)](https://github.com/tclindner/npm-package-json-lint) | | | [**JSON**](descriptors/json.md) | [**biome**](descriptors/json_biome.md)
[_JSON_BIOME_](descriptors/json_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**LATEX**](descriptors/latex.md) | [**chktex**](descriptors/latex_chktex.md)
[_LATEX_CHKTEX_](descriptors/latex_chktex.md) | | +| | [**LATEX**](descriptors/latex.md) | [**chktex**](descriptors/latex_chktex.md)
[_LATEX_CHKTEX_](descriptors/latex_chktex.md) | | | | [**MARKDOWN**](descriptors/markdown.md) | [**markdownlint**](descriptors/markdown_markdownlint.md)
[_MARKDOWN_MARKDOWNLINT_](descriptors/markdown_markdownlint.md) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | | | [**MARKDOWN**](descriptors/markdown.md) | [**markdown-table-formatter**](descriptors/markdown_markdown_table_formatter.md)
[_MARKDOWN_MARKDOWN_TABLE_FORMATTER_](descriptors/markdown_markdown_table_formatter.md) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | | | [**MARKDOWN**](descriptors/markdown.md) | [**rumdl**](descriptors/markdown_rumdl.md)
[_MARKDOWN_RUMDL_](descriptors/markdown_rumdl.md) | [![GitHub stars](https://img.shields.io/github/stars/rvben/rumdl?cacheSeconds=3600)](https://github.com/rvben/rumdl) ![formatter](https://shields.io/badge/-format-yellow) ![sarif](https://shields.io/badge/-SARIF-orange) | diff --git a/mega-linter-runner/README.md b/mega-linter-runner/README.md index a8df128bc29..aa0bde2201f 100644 --- a/mega-linter-runner/README.md +++ b/mega-linter-runner/README.md @@ -280,7 +280,7 @@ You can generate a ready-to-use [.mega-linter.yml configuration file](https://me | | [**CSS**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css.md) | [**stylelint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md)
[_CSS_STYLELINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | | | [**CSS**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_biome.md)
[_CSS_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | | | [**ENV**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env.md) | [**dotenv-linter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md)
[_ENV_DOTENV_LINTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md) | [**graphql-schema-linter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md)
[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md) | 🚫 [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md) | [**graphql-schema-linter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md)
[_GRAPHQL_GRAPHQL_SCHEMA_LINTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md) | 🚫 [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | | | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_biome.md)
[_GRAPHQL_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | | | [**HTML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html.md) | [**djlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_djlint.md)
[_HTML_DJLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_djlint.md) | [![GitHub stars](https://img.shields.io/github/stars/Riverside-Healthcare/djlint?cacheSeconds=3600)](https://github.com/Riverside-Healthcare/djlint) | | | [**HTML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html.md) | [**htmlhint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md)
[_HTML_HTMLHINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) ![sarif](https://shields.io/badge/-SARIF-orange) | @@ -289,7 +289,7 @@ You can generate a ready-to-use [.mega-linter.yml configuration file](https://me | | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**prettier**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md)
[_JSON_PRETTIER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | | | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**npm-package-json-lint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_npm_package_json_lint.md)
[_JSON_NPM_PACKAGE_JSON_LINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_npm_package_json_lint.md) | [![GitHub stars](https://img.shields.io/github/stars/tclindner/npm-package-json-lint?cacheSeconds=3600)](https://github.com/tclindner/npm-package-json-lint) | | | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md) | [**biome**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_biome.md)
[_JSON_BIOME_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_biome.md) | [![GitHub stars](https://img.shields.io/github/stars/biomejs/biome?cacheSeconds=3600)](https://github.com/biomejs/biome) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**LATEX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex.md) | [**chktex**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md)
[_LATEX_CHKTEX_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md) | | +| | [**LATEX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex.md) | [**chktex**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md)
[_LATEX_CHKTEX_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md) | | | | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md) | [**markdownlint**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md)
[_MARKDOWN_MARKDOWNLINT_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | | | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md) | [**markdown-table-formatter**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md)
[_MARKDOWN_MARKDOWN_TABLE_FORMATTER_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | | | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md) | [**rumdl**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_rumdl.md)
[_MARKDOWN_RUMDL_](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_rumdl.md) | [![GitHub stars](https://img.shields.io/github/stars/rvben/rumdl?cacheSeconds=3600)](https://github.com/rvben/rumdl) ![formatter](https://shields.io/badge/-format-yellow) ![sarif](https://shields.io/badge/-SARIF-orange) | From d451a8a13e4c30c87ee978acdc1bb1f2d4bf77ae Mon Sep 17 00:00:00 2001 From: nvuillam Date: Sun, 6 Sep 2026 08:35:01 +0200 Subject: [PATCH 3/4] [doc] Move MegaLinter vs Super-Linter under About --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 064ca0b17e4..3fbd47552db 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -84,7 +84,6 @@ nav: - "Getting Started": - "Which version to use ?": "install-version.md" - "Assisted Installation": "install-assisted.md" - - "MegaLinter vs Super-Linter": "mega-linter-vs-super-linter.md" - "FAQ": "frequently-asked-questions.md" - "Installation": - "Coding Agents": @@ -446,6 +445,7 @@ nav: - "Ollama": "llm-provider/llm_provider_ollama.md" - "Hugging Face": "llm-provider/llm_provider_huggingface.md" - "About": + - "MegaLinter vs Super-Linter": "mega-linter-vs-super-linter.md" - "They talk about MegaLinter": "articles.md" - "They use MegaLinter": "used-by-stats.md" - "Badge": "badge.md" From 8e73a67b18b9ca1f7298d8ab39ca94e242738c0a Mon Sep 17 00:00:00 2001 From: nvuillam Date: Sun, 6 Sep 2026 09:01:50 +0200 Subject: [PATCH 4/4] [doc] Rework navigation into 10 root entries + drop SARIF "beta" label Replaces the previous grouping, which relied on two vague umbrella sections ("Getting Started", "Reporting") and nested Installation three levels deep. Every root entry is now a concrete, searchable noun and the tree is at most two levels deep outside the generated linter/flavor lists. Root structure: - Home - Quick Start - Coding Agents (overview, Agent Skills, Agent Plugins) - Installation (which version, assisted, 7 CI platforms, Docker CLI, run locally, mega-linter-runner) - flat, no sub-menus - Configuration (config-* pages, LLM Advisor + providers, Linter Plugins) - Linters (supported, list, removed, 4 category trees) - Flavors (all, custom, generated flavors, statistics) - Reporters (17 reporters + Observability) - About (FAQ, vs Super-Linter, articles, used by, badge, thanks, sponsoring, contribute, license, changelog) - Try OX Security ASPM Flavors and Linters both sit back at root level, so build.py needs no change: the flavors / language / format / tooling_format / other generated blocks keep their original indentation and regenerate byte-identically. Also drops the "(beta)" label from the SARIF reporter in README.md, docs/reporters.md and docs/reporters/SarifReporter.md. --- .automation/build.py | 2 +- CHANGELOG.md | 7 +- README.md | 2 +- docs/reporters.md | 2 +- docs/reporters/SarifReporter.md | 2 +- mkdocs.yml | 143 +++++++++++++++----------------- 6 files changed, 77 insertions(+), 81 deletions(-) diff --git a/.automation/build.py b/.automation/build.py index cc7be38b00a..bc7ecea5aa5 100644 --- a/.automation/build.py +++ b/.automation/build.py @@ -2620,7 +2620,7 @@ def update_mkdocs_and_workflow_yml_with_flavors(): mkdocs_yml = [] gha_workflow_yml = [" flavor:", " ["] for flavor_id, _flavor_info in megalinter.flavor_factory.get_all_flavors().items(): - mkdocs_yml += [f' - "{flavor_id}": "flavors/{flavor_id}.md"'] + mkdocs_yml += [f' - "{flavor_id}": "flavors/{flavor_id}.md"'] gha_workflow_yml += [f' "{flavor_id}",'] gha_workflow_yml += [" ]"] # Update mkdocs.yml file diff --git a/CHANGELOG.md b/CHANGELOG.md index ed9a5a13006..d21660dbfb5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,13 +29,14 @@ Note: Can be used with `oxsecurity/megalinter@beta` in your GitHub Action mega-l - Fixes - Reporters + - The **SARIF Reporter** is not flagged as **beta** anymore in the documentation - Flavors - Doc - - The [documentation](https://megalinter.io) menu is reorganized from **24 root entries down to 9**: pages are now grouped under **Getting Started**, **Installation**, **Configuration**, **Linters**, **Reporting** and **About**, so the sidebar can be scanned at a glance - - **Installation** groups the CI/CD platforms, the coding agents and the local usage pages in three sub-menus - - **Flavors** and **Linter Plugins** moved under **Configuration**, **Observability** and **LLM Advisor** under **Reporting** + - The [documentation](https://megalinter.io) menu is reorganized from **24 root entries down to 10**, so the sidebar can be scanned at a glance + - **Coding Agents**, **Installation**, **Configuration**, **Linters**, **Flavors**, **Reporters** and **About** are now the main entries + - **Observability** moved under **Reporters**, **LLM Advisor** and **Linter Plugins** under **Configuration** - All documentation **URLs are unchanged**: only the menu structure was updated - mega-linter-runner diff --git a/README.md b/README.md index 59e0d05cc0e..a527b129f76 100644 --- a/README.md +++ b/README.md @@ -1795,7 +1795,7 @@ MegaLinter can generate various reports that you can activate or deactivate and | Reporter | Description | Default | |------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|------------------------------| | [Text files](https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/TextReporter.md) | Generates **One log file by linter** + suggestions for fixes that can not be automated | Active | -| [SARIF (beta)](https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/SarifReporter.md) | Generates an aggregated SARIF output file | Inactive | +| [SARIF](https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/SarifReporter.md) | Generates an aggregated SARIF output file | Inactive | | [GitHub Pull Request comments](https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/GitHubCommentReporter.md) | MegaLinter posts a comment on the PR with a summary of lint results, and links to detailed logs | Active if GitHub Action | | [Gitlab Merge Request comments](https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/GitlabCommentReporter.md) | Mega-Linter posts a comment on the MR with a summary of lint results, and links to detailed logs | Active if in Gitlab CI | | [Azure Pipelines Pull Request comments](https://github.com/oxsecurity/megalinter/tree/main/docs/reporters/AzureCommentReporter.md) | Mega-Linter posts a comment on the PR with a summary of lint results, and links to detailed logs | Active if in Azure Pipelines | diff --git a/docs/reporters.md b/docs/reporters.md index ed94911d83f..94713cc8570 100644 --- a/docs/reporters.md +++ b/docs/reporters.md @@ -13,7 +13,7 @@ MegaLinter can generate various reports that you can activate or deactivate and | Reporter | Description | Default | |----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|------------------------------| | [Text files](reporters/TextReporter.md) | Generates **One log file by linter** + suggestions for fixes that can not be automated | Active | -| [SARIF (beta)](reporters/SarifReporter.md) | Generates an aggregated SARIF output file | Inactive | +| [SARIF](reporters/SarifReporter.md) | Generates an aggregated SARIF output file | Inactive | | [GitHub Pull Request comments](reporters/GitHubCommentReporter.md) | MegaLinter posts a comment on the PR with a summary of lint results, and links to detailed logs | Active if GitHub Action | | [Gitlab Merge Request comments](reporters/GitlabCommentReporter.md) | Mega-Linter posts a comment on the MR with a summary of lint results, and links to detailed logs | Active if in Gitlab CI | | [Azure Pipelines Pull Request comments](reporters/AzureCommentReporter.md) | Mega-Linter posts a comment on the PR with a summary of lint results, and links to detailed logs | Active if in Azure Pipelines | diff --git a/docs/reporters/SarifReporter.md b/docs/reporters/SarifReporter.md index 3dab963f820..175ee0986af 100644 --- a/docs/reporters/SarifReporter.md +++ b/docs/reporters/SarifReporter.md @@ -3,7 +3,7 @@ title: SARIF Reporter for MegaLinter description: Generates SAST results in SARIF format within a file named mega-linter-report.sarif, located in report folder --- -# SARIF Reporter (beta) +# SARIF Reporter Generates a full execution log in SARIF format within a file named **mega-linter-report.sarif** , located in report folder. diff --git a/mkdocs.yml b/mkdocs.yml index 3fbd47552db..d7104547f0e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -81,27 +81,23 @@ extra: nav: - "Home": "index.md" - "Quick Start": "quick-start.md" - - "Getting Started": + - "Coding Agents": + - "Use MegaLinter with coding agents": "coding-agents.md" + - "Agent Skills": "install-agent-skills.md" + - "Agent Plugins": "agent-plugins.md" + - "Installation": - "Which version to use ?": "install-version.md" - "Assisted Installation": "install-assisted.md" - - "FAQ": "frequently-asked-questions.md" - - "Installation": - - "Coding Agents": - - "Coding Agents": "coding-agents.md" - - "Agent Skills": "install-agent-skills.md" - - "Agent Plugins": "agent-plugins.md" - - "CI/CD Platforms": - - "GitHub Actions": "install-github.md" - - "Gitlab CI": "install-gitlab.md" - - "Azure Pipelines": "install-azure.md" - - "Bitbucket Pipelines": "install-bitbucket.md" - - "Jenkins": "install-jenkins.md" - - "Concourse CI": "install-concourse.md" - - "Drone CI": "install-drone.md" - - "Local usage": - - "Docker (CLI)": "install-docker.md" - - "Run locally": "install-locally.md" - - "mega-linter-runner": "mega-linter-runner.md" + - "GitHub Actions": "install-github.md" + - "Gitlab CI": "install-gitlab.md" + - "Azure Pipelines": "install-azure.md" + - "Bitbucket Pipelines": "install-bitbucket.md" + - "Jenkins": "install-jenkins.md" + - "Concourse CI": "install-concourse.md" + - "Drone CI": "install-drone.md" + - "Docker (CLI)": "install-docker.md" + - "Run locally": "install-locally.md" + - "mega-linter-runner": "mega-linter-runner.md" - "Configuration": - ".mega-linter.yml file": "config-file.md" - "Common Variables": "config-variables.md" @@ -113,30 +109,17 @@ nav: - "Post-commands": "config-postcommands.md" - "ENV variables security": "config-variables-security.md" - "CLI lint mode": "config-cli-lint-mode.md" - - "Flavors": - - "All flavors": "flavors.md" - - "Custom flavors": "custom-flavors.md" - # flavors-start - - "c_cpp": "flavors/c_cpp.md" - - "ci_light": "flavors/ci_light.md" - - "cupcake": "flavors/cupcake.md" - - "documentation": "flavors/documentation.md" - - "dotnet": "flavors/dotnet.md" - - "dotnetweb": "flavors/dotnetweb.md" - - "formatters": "flavors/formatters.md" - - "go": "flavors/go.md" - - "java": "flavors/java.md" - - "javascript": "flavors/javascript.md" - - "php": "flavors/php.md" - - "python": "flavors/python.md" - - "ruby": "flavors/ruby.md" - - "rust": "flavors/rust.md" - - "salesforce": "flavors/salesforce.md" - - "security": "flavors/security.md" - - "swift": "flavors/swift.md" - - "terraform": "flavors/terraform.md" -# flavors-end - - "Flavors statistics": "flavors-stats.md" + - "LLM Advisor": + - "AI-Powered Fix Suggestions": "llm-advisor.md" + - "All LLM providers": "llm-providers.md" + - "Anthropic": "llm-provider/llm_provider_anthropic.md" + - "DeepSeek": "llm-provider/llm_provider_deepseek.md" + - "Google GenAI": "llm-provider/llm_provider_google_genai.md" + - "MistralAI": "llm-provider/llm_provider_mistralai.md" + - "OpenAI": "llm-provider/llm_provider_openai.md" + - "OrcaRouter": "llm-provider/llm_provider_orcarouter.md" + - "Ollama": "llm-provider/llm_provider_ollama.md" + - "Hugging Face": "llm-provider/llm_provider_huggingface.md" - "Linter Plugins": "plugins.md" - "Linters": - "All supported linters": "supported-linters.md" @@ -407,44 +390,56 @@ nav: - "lychee": "descriptors/spell_lychee.md" - "codespell": "descriptors/spell_codespell.md" # other-end - - "Reporting": - - "Reporters": - - "All reporters": "reporters.md" - - "Text files": "reporters/TextReporter.md" - - "GitHub Pull Request comments": "reporters/GitHubCommentReporter.md" - - "Gitlab Merge Request comments": "reporters/GitlabCommentReporter.md" - - "Azure Pull Request comments": "reporters/AzureCommentReporter.md" - - "Bitbucket Pull Request comments": "reporters/BitbucketCommentReporter.md" - - "API / Observability": "reporters/ApiReporter.md" - - "GitHub Status": "reporters/GitHubStatusReporter.md" - - "SARIF Reporter": "reporters/SarifReporter.md" - - "Updated sources": "reporters/UpdatedSourcesReporter.md" - - "E-mail": "reporters/EmailReporter.md" - - "File.io": "reporters/FileIoReporter.md" - - "IDE Configuration": "reporters/ConfigReporter.md" - - "TAP files": "reporters/TapReporter.md" - - "Console": "reporters/ConsoleReporter.md" - - "JSON": "reporters/JsonReporter.md" - - "Markdown Summary": "reporters/MarkdownSummaryReporter.md" + - "Flavors": + - "All flavors": "flavors.md" + - "Custom flavors": "custom-flavors.md" + # flavors-start + - "c_cpp": "flavors/c_cpp.md" + - "ci_light": "flavors/ci_light.md" + - "cupcake": "flavors/cupcake.md" + - "documentation": "flavors/documentation.md" + - "dotnet": "flavors/dotnet.md" + - "dotnetweb": "flavors/dotnetweb.md" + - "formatters": "flavors/formatters.md" + - "go": "flavors/go.md" + - "java": "flavors/java.md" + - "javascript": "flavors/javascript.md" + - "php": "flavors/php.md" + - "python": "flavors/python.md" + - "ruby": "flavors/ruby.md" + - "rust": "flavors/rust.md" + - "salesforce": "flavors/salesforce.md" + - "security": "flavors/security.md" + - "swift": "flavors/swift.md" + - "terraform": "flavors/terraform.md" +# flavors-end + - "Flavors statistics": "flavors-stats.md" + - "Reporters": + - "All reporters": "reporters.md" + - "Text files": "reporters/TextReporter.md" + - "GitHub Pull Request comments": "reporters/GitHubCommentReporter.md" + - "Gitlab Merge Request comments": "reporters/GitlabCommentReporter.md" + - "Azure Pull Request comments": "reporters/AzureCommentReporter.md" + - "Bitbucket Pull Request comments": "reporters/BitbucketCommentReporter.md" + - "API / Observability": "reporters/ApiReporter.md" + - "GitHub Status": "reporters/GitHubStatusReporter.md" + - "SARIF Reporter": "reporters/SarifReporter.md" + - "Updated sources": "reporters/UpdatedSourcesReporter.md" + - "E-mail": "reporters/EmailReporter.md" + - "File.io": "reporters/FileIoReporter.md" + - "IDE Configuration": "reporters/ConfigReporter.md" + - "TAP files": "reporters/TapReporter.md" + - "Console": "reporters/ConsoleReporter.md" + - "JSON": "reporters/JsonReporter.md" + - "Markdown Summary": "reporters/MarkdownSummaryReporter.md" - "Observability": - "Observability home": "observability.md" - "Grafana": "observability/grafana.md" - "Datadog": "observability/datadog.md" - "Elastic": "observability/elastic.md" - "New Relic": "observability/newrelic.md" - - "LLM Advisor": - - "LLM Advisor": "llm-advisor.md" - - "LLM Providers": - - "All LLM providers": "llm-providers.md" - - "Anthropic": "llm-provider/llm_provider_anthropic.md" - - "DeepSeek": "llm-provider/llm_provider_deepseek.md" - - "Google GenAI": "llm-provider/llm_provider_google_genai.md" - - "MistralAI": "llm-provider/llm_provider_mistralai.md" - - "OpenAI": "llm-provider/llm_provider_openai.md" - - "OrcaRouter": "llm-provider/llm_provider_orcarouter.md" - - "Ollama": "llm-provider/llm_provider_ollama.md" - - "Hugging Face": "llm-provider/llm_provider_huggingface.md" - "About": + - "FAQ": "frequently-asked-questions.md" - "MegaLinter vs Super-Linter": "mega-linter-vs-super-linter.md" - "They talk about MegaLinter": "articles.md" - "They use MegaLinter": "used-by-stats.md"