The snipcheck package

[Tags:library, mit]

Markdown snippet runner and checker


[Skip to Readme]

Properties

Versions 0.1.0.0
Dependencies base (>=4.7 && <5), pandoc (>=1.19.2.1 && <1.20), process (>=1.4.3.0 && <1.5) [details]
License MIT
Copyright 2017 Nicolas Mattia
Author Nicolas Mattia
Maintainer nicolas@nmattia.com
Category Development
Home page https://github.com/nmattia/snipcheck#readme
Uploaded Tue Mar 7 20:13:26 UTC 2017 by nmattia
Distributions NixOS:0.1.0.0
Downloads 27 total (10 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2017-03-07 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for snipcheck

Readme for snipcheck-0.1.0.0

Snipcheck

Snipcheck makes sure that the code snippets in markdown files are up-to-date.

This is very much a work in progress. The only function currently available is

checkMarkdownFile :: FilePath -> IO ()

that will run shell snippets and errored out if the output doesn't match the snippet. You can skip some of the output with ....

Example:

# Some title

some markdown content

``` shell
$ echo foo; echo bar; echo baz; echo qux
foo
...
qux
```

some more content