Skip to content

Tool to validate Markdown files.

License

Notifications You must be signed in to change notification settings

hubci/md-proofer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Proofer CircleCI Build Status GitHub License

Tool to validate Markdown files. If you have ideas on how to make this tool better, please open an Issue.

Installation

You can install an official release of Markdown Proofer from the Releases Page. Currently this is an amd64 (64-bit) Linux binary.

You can get the latest code for development or to compile your own binaries via go install:

$ go install github.com/hubci/md-proofer

Usage

This section is still a work-in-progress. For now, this blog post is the best resource on how to use this tool.