Skip to content
Permalink
Browse files

Add documentation of the npm package to README.md.

Thanks to Shawn Erquhart.
  • Loading branch information...
jgm committed May 28, 2019
1 parent 6000708 commit 5acccafe171778a0b1e2c0092cba6fd629043a6d
Showing with 15 additions and 0 deletions.
  1. +15 −0 README.md
@@ -39,6 +39,21 @@ actually running the tests, you can do:

and you'll get all the tests in JSON format.

JavaScript developers may find it more convenient to use the
[`commonmark-spec` npm package], which is published from this
repository. It exports an array `tests` of JSON objects with
the format

```json
{
"markdown": "Foo\nBar\n---\n",
"html": "<h2>Foo\nBar</h2>\n",
"section": "Setext headings",
"number": 65
}
```

[`commonmark-spec` npm package]: https://www.npmjs.com/package/commonmark-spec

The spec
--------

0 comments on commit 5acccaf

Please sign in to comment.
You can’t perform that action at this time.