snipcheck: Markdown tester

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Markdown snippet runner and checker

[Skip to Readme]


Change log None available
Dependencies base (>=4.7 && <5), containers, pandoc, process, text [details]
License MIT
Copyright 2017 Nicolas Mattia
Author Nicolas Mattia
Category Development
Home page
Uploaded by nmattia at 2018-10-14T15:45:49Z


[Index] [Quick Jump]


Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Readme for snipcheck-

[back to package description]


Build Status

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 ....


# Some title

some markdown content

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

some more content

Release check-list

  1. Make sure you're on master

  2. Bump the version in snipcheck.cabal:

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes, MINOR version when you add functionality in a backwards-compatible manner, and PATCH version when you make backwards-compatible bug fixes.

  1. Run cabal sdit and cabal upload ./dist/snipcheck-... to upload snipcheck to hackage
  2. Commit the updated snipcheck.cabal file.