mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-22 05:40:48 +02:00
Add mention of CommonMark to project description (fixes #15).
This commit is contained in:
parent
955ae5f390
commit
624ae4952b
5 changed files with 6 additions and 7 deletions
|
@ -1,6 +1,6 @@
|
|||
# markdownlint
|
||||
|
||||
> A Node.js style checker and lint tool for Markdown files.
|
||||
> A Node.js style checker and lint tool for Markdown/CommonMark files.
|
||||
|
||||
[![npm version][npm-image]][npm-url]
|
||||
[![GitHub tag][github-tag-image]][github-tag-url]
|
||||
|
@ -20,7 +20,8 @@ The [Markdown](http://en.wikipedia.org/wiki/Markdown) markup language is
|
|||
designed to be easy to read, write, and understand. It succeeds - and its
|
||||
flexibility is both a benefit and a drawback. Many styles are possible, so
|
||||
formatting can be inconsistent. Some constructs don't work well in all
|
||||
parsers and should be avoided.
|
||||
parsers and should be avoided. The [CommonMark](http://commonmark.org/)
|
||||
specification standardizes parsers - but not authors.
|
||||
|
||||
`markdownlint` is a [static analysis](http://en.wikipedia.org/wiki/Static_program_analysis)
|
||||
tool for [Node.js](https://nodejs.org/) and [io.js](https://iojs.org/) with a
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="utf-8"/>
|
||||
<link href="default.css" rel="stylesheet" type="text/css"/>
|
||||
<link rel="shortcut icon" href="favicon.ico"/>
|
||||
<meta name="description" content="Demo for markdownlint, a Node.js style checker and lint tool for Markdown files."/>
|
||||
<meta name="description" content="Demo for markdownlint, a Node.js style checker and lint tool for Markdown/CommonMark files."/>
|
||||
<title>markdownlint demo</title>
|
||||
<base target="_blank"/>
|
||||
</head>
|
||||
|
|
|
@ -122,7 +122,7 @@
|
|||
markdown.value = [
|
||||
"## Introduction",
|
||||
"",
|
||||
"`markdownlint` is a [Node.js](https://nodejs.org/)/[io.js](https://iojs.org/) style checker and lint tool for [Markdown](http://en.wikipedia.org/wiki/Markdown) files to automatically validate content, prevent rendering problems, and promote consistency.",
|
||||
"`markdownlint` is a [Node.js](https://nodejs.org/)/[io.js](https://iojs.org/) style checker and lint tool for [Markdown](http://en.wikipedia.org/wiki/Markdown)/[CommonMark](http://commonmark.org/) files to automatically validate content, prevent rendering problems, and promote consistency.",
|
||||
"This page offers an easy way to try it out interactively!",
|
||||
"",
|
||||
"#### Instructions",
|
||||
|
|
|
@ -34,7 +34,6 @@ level at a time:
|
|||
|
||||
### Another Header 3
|
||||
|
||||
|
||||
## MD002 - First header should be a h1 header
|
||||
|
||||
Tags: headers
|
||||
|
@ -157,7 +156,6 @@ line:
|
|||
|
||||
To fix, ensure that top level list items are not indented:
|
||||
|
||||
|
||||
Some test
|
||||
|
||||
* List item
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "markdownlint",
|
||||
"version": "0.1.1",
|
||||
"description": "A Node.js style checker and lint tool for Markdown files.",
|
||||
"description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
|
||||
"main": "lib/markdownlint.js",
|
||||
"author": "David Anson (http://dlaa.me/)",
|
||||
"license": "MIT",
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue