98 lines (80 loc) · 40 KB

title	documentation flavor in MegaLinter
description	documentation flavor is an optimized MegaLinter with only linters related to documentation projects

documentation MegaLinter Flavor

Description

MegaLinter for documentation projects

Usage

GitHub Action: oxsecurity/megalinter/flavors/documentation@beta
Docker images:
- GitHub Packages: ghcr.io/oxsecurity/megalinter-documentation:beta
- Docker Hub: docker.io/oxsecurity/megalinter-documentation:beta
mega-linter-runner: mega-linter-runner --flavor documentation

Embedded linters

Languages

	Language	Linter	Additional
	BASH	bash-exec BASH_EXEC
	BASH	shellcheck BASH_SHELLCHECK
	BASH	shfmt BASH_SHFMT
	GROOVY	npm-groovy-lint GROOVY_NPM_GROOVY_LINT
	KOTLIN	ktlint KOTLIN_KTLINT
	KOTLIN	detekt KOTLIN_DETEKT
	SQL	sqlfluff SQL_SQLFLUFF

Formats

	Format	Linter	Additional
	CSS	stylelint CSS_STYLELINT
	ENV	dotenv-linter ENV_DOTENV_LINTER
	GRAPHQL	graphql-schema-linter GRAPHQL_GRAPHQL_SCHEMA_LINTER
	HTML	djlint HTML_DJLINT
	HTML	htmlhint HTML_HTMLHINT
	JSON	jsonlint JSON_JSONLINT
	JSON	v8r JSON_V8R
	JSON	prettier JSON_PRETTIER
	MARKDOWN	markdownlint MARKDOWN_MARKDOWNLINT
	MARKDOWN	markdown-table-formatter MARKDOWN_MARKDOWN_TABLE_FORMATTER
	MARKDOWN	rumdl MARKDOWN_RUMDL
	PROTOBUF	protolint PROTOBUF_PROTOLINT
	XML	xmllint XML_XMLLINT
	YAML	prettier YAML_PRETTIER
	YAML	yamllint YAML_YAMLLINT
	YAML	v8r YAML_V8R

Tooling formats

	Tooling format	Linter	Additional
	ACTION	actionlint ACTION_ACTIONLINT
	ACTION	zizmor ACTION_ZIZMOR
	ANSIBLE	ansible-lint ANSIBLE_ANSIBLE_LINT
	DOCKERFILE	hadolint DOCKERFILE_HADOLINT
	EDITORCONFIG	editorconfig-checker EDITORCONFIG_EDITORCONFIG_CHECKER
	KUBERNETES	kubeconform KUBERNETES_KUBECONFORM
	KUBERNETES	helm KUBERNETES_HELM
	KUBERNETES	kubescape KUBERNETES_KUBESCAPE
	SNAKEMAKE	snakemake SNAKEMAKE_LINT
	SNAKEMAKE	snakefmt SNAKEMAKE_SNAKEFMT
	TEKTON	tekton-lint TEKTON_TEKTON_LINT

Other

	Code quality checker	Linter	Additional
	COPYPASTE	jscpd COPYPASTE_JSCPD
	REPOSITORY	checkov REPOSITORY_CHECKOV
	REPOSITORY	git_diff REPOSITORY_GIT_DIFF
	REPOSITORY	gitleaks REPOSITORY_GITLEAKS
	REPOSITORY	grype REPOSITORY_GRYPE
	REPOSITORY	ls-lint REPOSITORY_LS_LINT
	REPOSITORY	osv-scanner REPOSITORY_OSV_SCANNER
	REPOSITORY	secretlint REPOSITORY_SECRETLINT
	REPOSITORY	semgrep REPOSITORY_SEMGREP
	REPOSITORY	syft REPOSITORY_SYFT
	REPOSITORY	trivy REPOSITORY_TRIVY
	REPOSITORY	trivy-sbom REPOSITORY_TRIVY_SBOM
	REPOSITORY	trufflehog REPOSITORY_TRUFFLEHOG
	SPELL	cspell SPELL_CSPELL
	SPELL	proselint SPELL_PROSELINT
	SPELL	vale SPELL_VALE
	SPELL	lychee SPELL_LYCHEE
	SPELL	codespell SPELL_CODESPELL