8ad433d4ad
Move the tool as a dependency for static checks migration. Fixes #8187 Signed-off-by: Bin Liu <bin@hyper.sh> Signed-off-by: Chelsea Mafrica <chelsea.e.mafrica@intel.com> Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com> Signed-off-by: Ganesh Maharaj Mahalingam <ganesh.mahalingam@intel.com> Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com> Signed-off-by: Julio Montes <julio.montes@intel.com> |
||
|---|---|---|
| .. | ||
| add_test.go | ||
| add.go | ||
| check.go | ||
| display_text.go | ||
| display_tsv.go | ||
| display.go | ||
| doc.go | ||
| extract.go | ||
| hack.go | ||
| heading_test.go | ||
| heading.go | ||
| link_test.go | ||
| link.go | ||
| main.go | ||
| Makefile | ||
| node.go | ||
| parse.go | ||
| README.md | ||
| record.go | ||
| search.go | ||
| stats.go | ||
| toc.go | ||
| types.go | ||
| utils_test.go | ||
| utils.go | ||
| VERSION | ||
Overview
The Kata Project comprises a number of GitHub repositories. All these repositories contain documents written in GitHub-Flavoured Markdown format.
Linking in documents is strongly encouraged but due to the number of internal and external document links, it is easy for mistakes to be made. Also, links can become stale when one document is updated but the documents it depends on are not.
Tool summary
The kata-check-markdown tool checks a markdown document to ensure all links
within it are valid. All internal links are checked and by default all
external links are also checked. The tool is able to suggest corrections for
some errors it finds. It can also generate a TOC (table of contents).
Usage
Basic
$ kata-check-markdown check README.md
Generate a TOC
$ kata-check-markdown toc README.md
List headings
To list the document headings in the default text format:
$ kata-check-markdown list headings README.md
List links
To list the links in a document in tab-separated format:
$ kata-check-markdown list links --format tsv README.md
Full details
Lists all available options:
$ kata-check-markdown -h