check-markdown

README

• Overview
• Tool summary
• Usage
  • Basic
  • Generate a TOC
  • List headings
  • List links
  • Full details

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