readme-lhs

Literate programming support.

This package provides support for literate programming in haskell, including:

• conversion between *.lhs and *.hs formats.

• insertion of program output into *.lhs and *.md for fast feedback in development.

• a simple wrapper for pandoc functionality.

• a stack template, `readme-lhs`

Usage

The best way to understand package functionality is to run the example.hs, with:

stack build --test --exec "$(stack path --local-install-root)/bin/readme-lhs-example --file-watch

import Readme.Lhs
main =
  void $
  runOutput ("other/readme_.md", GitHubMarkdown) ("readme.md", GitHubMarkdown) $
  output "example" (Fence "Simple example of an output")

Template

To use the provided template, copy readme-lhs.hsfiles to a local directory, and try:

stack new xyzzy readme-lhs