snipcheck: Markdown tester

[ development, library, mit ] [ Propose Tags ]

Markdown snippet runner and checker


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3
Dependencies base (>=4.7 && <5), containers (>=0.5.7.1 && <0.6), 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 by nmattia at Thu May 25 12:55:06 UTC 2017
Distributions NixOS:0.1.0.3
Downloads 949 total (27 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2017-05-25 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for snipcheck-0.1.0.1

[back to package description]

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