Monadoc

readme-lhs

Version 0.8.1 revision 0 uploaded by tonyday567.

Package meta

Synopsis
Literate programming support.
Description

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
Author
Tony Day
Bug reports
https://github.com/tonyday567/readme-lhs/issues
Category
Development
Copyright
2016 Tony Day
Homepage
https://github.com/tonyday567/readme-lhs#readme
Maintainer
tonyday567@gmail.com
Package URL
n/a
Stability
n/a

Components