Skip to content

Instantly share code, notes, and snippets.

@charlesreid1
Created May 22, 2018 05:01
Show Gist options
  • Save charlesreid1/c8ac98e4362e98e9d789768b6f0f70cb to your computer and use it in GitHub Desktop.
Save charlesreid1/c8ac98e4362e98e9d789768b6f0f70cb to your computer and use it in GitHub Desktop.
demonstrating markdown linting
$ mdl simple.md
simple.md:15: MD009 Trailing spaces
simple.md:19: MD009 Trailing spaces
simple.md:5: MD018 No space after hash on atx style header
simple.md:13: MD018 No space after hash on atx style header
simple.md:5: MD025 Multiple top level headers in the same document
simple.md:17: MD037 Spaces inside emphasis markers
simple.md:21: MD037 Spaces inside emphasis markers
all # Use all markdownlint rules
# Disable line length check for tables and code blocks
rule 'MD013', :line_length => 80, :code_blocks => false, :tables => false
# Set Ordered list item prefix to "ordered" (use 1. 2. 3. not 1. 1. 1.)
rule 'MD029', :style => "ordered"

This header is fine

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula.

#This header is faulty

Eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient.

This subheader is fine

Montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque.

##This subheader is faulty

Lorem ipsum dolor sit amet, consectetuer adipiscing elit.

**Aenean commodo ** ligula montes, nascetur ridiculus mus.

Eu, pretium quis, sem. Nulla consequat massa quis enim.

*Donec pede * justo, fringilla vel, aliquet nec, vulputate eget.

Integer tincidunt *cras dapibus vivamus *elementum semper nisi aenean vulputate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment