Skip to content

Commit

Permalink
Update readme.md to reflect screenshot.png
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Jan 9, 2016
1 parent 9c48497 commit b2c4637
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,27 +53,21 @@ Let’s say `example.md` looks as follows:
```md
* Hello

- World
[World][]
```

Then, to run **remark-lint** on `example.md`:

```bash
remark -u remark-lint example.md
remark example.md -u remark-lint
#
# Yields:
#
# example.md
# 1:3 warning Incorrect list-item content indent: add 2 spaces list-item-indent
# 3:1 warning Invalid ordered list item marker: should be `*` unordered-list-marker-style
#
# ✖ 2 problems (0 errors, 2 warnings)
#
# * Hello
#
#
# * World
# 1:3 warning Incorrect list-item indent: add 2 spaces list-item-indent
# 3:1-3:10 warning Found reference to undefined definition no-undefined-references
#
# ⚠ 2 warnings
```

See [doc/rules.md](doc/rules.md) for what those warnings are (and how to
Expand Down

0 comments on commit b2c4637

Please sign in to comment.