readme-lhs: Literate programming support.

[ bsd3, development, library, program ] [ Propose Tags ]

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

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

[Skip to Readme]
Versions [faq] 0.1.0.0, 0.2.0, 0.2.1, 0.2.2, 0.3.0, 0.4.0, 0.5.0, 0.6.0, 0.7.0, 0.8.0, 0.8.1
Dependencies attoparsec (==0.13.*), base (>=4.7 && <5), blaze-html (>=0.9), containers (>=0.6), foldl (>=1.4), generic-lens (>=1.2 && <3.0), numhask (==0.7.*), pandoc (>=2.10), pandoc-types (>=1.21), readme-lhs, text (>=1.2), transformers (>=0.5) [details]
License BSD-3-Clause
Copyright 2016 Tony Day
Author Tony Day
Maintainer tonyday567@gmail.com
Category Development
Home page https://github.com/tonyday567/readme-lhs#readme
Bug tracker https://github.com/tonyday567/readme-lhs/issues
Source repo head: git clone https://github.com/tonyday567/readme-lhs
Uploaded by tonyday567 at 2020-11-27T20:55:58Z
Distributions NixOS:0.8.1
Executables readme-lhs-example
Downloads 2402 total (14 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for readme-lhs-0.8.1

[back to package description]

readme-lhs

Build
Status Hackage

<blockquote cite> The language in which we express our ideas has a strong influence on our thought processes ~ Knuth </blockquote>

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

example insert

Simple example of an output

template

A bare bones stack template is located in other/readme-lhs.hsfiles. It contains what you need to quickly get started with literate programming and enjoy a rapid workflow

Place this in a local directory and then:

stack new xyzzy readme-lhs
cd xyzzy
stack build

will get you bootstrapped and ready to hack!

development

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