markdown linting

[andrewcboardman]

What?

lints markdown

Why?

enables us to maintain code quality elsewhere more easily

[github-actions]

🦙 MegaLinter status: ❌ ERROR

Descriptor	Linter	Files	Fixed	Errors	Warnings	Elapsed time
⚠️ BASH	bash-exec	1		1	0	0.0s
✅ BASH	shellcheck	1		0	0	0.01s
✅ BASH	shfmt	1		0	0	0.0s
✅ COPYPASTE	jscpd	yes		no	no	1.35s
✅ JSON	jsonlint	1		0	0	0.14s
✅ JSON	v8r	1		0	0	2.25s
⚠️ MARKDOWN	markdownlint	6		8	0	0.64s
❌ MARKDOWN	markdown-link-check	6		4	0	4.27s
✅ MARKDOWN	markdown-table-formatter	6		0	0	0.25s
✅ REPOSITORY	checkov	yes		no	no	18.43s
✅ REPOSITORY	devskim	yes		no	no	1.43s
✅ REPOSITORY	dustilock	yes		no	no	0.01s
✅ REPOSITORY	gitleaks	yes		no	no	0.1s
✅ REPOSITORY	git_diff	yes		no	no	0.0s
❌ REPOSITORY	grype	yes		25	no	28.29s
❌ REPOSITORY	kics	yes		2	no	1.81s
✅ REPOSITORY	secretlint	yes		no	no	0.57s
✅ REPOSITORY	syft	yes		no	no	1.53s
❌ REPOSITORY	trivy	yes		1	no	9.71s
✅ REPOSITORY	trivy-sbom	yes		no	no	1.87s
✅ REPOSITORY	trufflehog	yes		no	no	3.52s
❌ SPELL	lychee	14		6	0	0.61s
✅ YAML	v8r	6		0	0	5.55s
❌ YAML	yamllint	6		2	0	0.45s

See detailed report in MegaLinter reports

You could have the same capabilities but better runtime performances if you use a MegaLinter flavor:

• oxsecurity/megalinter/flavors/terraform@v8.7.0 (54 linters)
• oxsecurity/megalinter/flavors/cupcake@v8.7.0 (88 linters)

[timgentry]

@copilot update the changelog following keepachangelog conventions, thanks

[Copilot]

@timgentry I've opened a new pull request, #7, to work on those changes. Once the pull request is ready, I'll request review from you.

[timgentry]

@copilot just contribute to this PR and close the other PR you just created.

[Copilot]

@timgentry I've opened a new pull request, #8, to work on those changes. Once the pull request is ready, I'll request review from you.