History

dependabot[bot] ef098557ba chore(deps): Bump github.com/yuin/goldmark from 1.6.0 to 1.7.8 (#16467 ) Co-authored-by: Dane Strandboge <dstrandboge@influxdata.com>		2025-02-04 20:54:47 +01:00
..
README.md	chore: add readme linter (#10916 )	2022-04-19 11:59:25 -06:00
assert.go	chore(deps): Bump github.com/yuin/goldmark from 1.6.0 to 1.7.8 (#16467 )	2025-02-04 20:54:47 +01:00
main.go	chore: Enable `revive:enforce-slice-style` rule (#16173 )	2024-11-13 01:24:35 -06:00
plugin.go	chore(readme_linter): Update plugin type guess logic (#15010 )	2024-03-18 16:06:28 -05:00
rules.go	chore(deps): Bump github.com/yuin/goldmark from 1.6.0 to 1.7.8 (#16467 )	2025-02-04 20:54:47 +01:00
set.go	chore: add readme linter (#10916 )	2022-04-19 11:59:25 -06:00

README.md linter

Building

telegraf/tools/readme_linter$ go build .

Run readme_linter with the filenames of the readme files you want to lint.

telegraf/tools/readme_linter$ ./readme_linter <path to readme>

You can lint multiple filenames at once. This works well with shell globs.

To lint all the plugin readmes:

telegraf/tools/readme_linter$ ./readme_linter ../../plugins/*/*/README.md

To lint readmes for inputs starting a-d:

telegraf/tools/readme_linter$ ./readme_linter ../../plugins/inputs/[a-d]*/README.md