Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

unexpected-markdown

1.7.4 • Public • Published

This module uses the markdown parser marked to generate html output from markdown files. In addition to what marked already offers, this module uses magicpen-prism to syntax highlight code blocks and uses unexpected to evaluate JavaScript code examples.

Right now the documentation for this plugin is pretty lacking, until that is fixed the best example on how to use the plugin is to look at how it is used in unexpected.

An example is a JavaScript code block:

```js
helloWorld()
```

If you expect the example to fail, you can follow the code block with an expected output block:

```output
Error: Silence this is a library!
```

There are a few things you can achieve more then what is explained above, like async examples with promises and skiping examples for different environments or just skipping evaluation altogether. For now you'll have to look at how unexpected does it to learn the ticks.

install

npm i unexpected-markdown

Downloadsweekly downloads

47

version

1.7.4

license

MIT

repository

githubgithub

last publish

collaborators

  • avatar
  • avatar