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.8 && <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
Revised Revision 1 made by HerbertValerioRiedel at Thu May 25 20:24:24 UTC 2017
Category Development
Home page https://github.com/nmattia/snipcheck#readme
Uploaded by nmattia at Tue Mar 7 20:13:26 UTC 2017
Distributions NixOS:0.1.0.3
Downloads 1079 total (74 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-03-07 [all 1 reports]

Modules

[Index]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for snipcheck-0.1.0.0

[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