superdoc

Additional documentation markup and Unicode support

http://www.mathstat.dal.ca/~selinger/superdoc/

Latest on Hackage:0.1.2.9

This package is not currently in any snapshots. If you're interested in using it, we recommend adding it to Stackage Nightly. Doing so will make builds more reliable, and allow stackage.org to host generated Haddocks.

BSD-3-Clause licensed by Peter Selinger
Maintained by [email protected]

This package extends Cabal's documentation building capabilities. It extends the Haddock markup language with syntax for subscripts, superscripts, and more. Recent version of Haddock already support bold text and the inclusion of images; however, we continue to provide markup for these for backward compatibility with earlier versions of Superdoc.

This package is designed to work transparently. It provides a custom main function that package maintainers can use in their Setup.hs file. In most cases, this is as simple as setting the build-type to Custom, adding superdoc to the package dependencies, and putting the following two lines into Setup.hs:

import Distribution.Superdoc
main = superdocMain

For more information on the available markup, see Distribution.Superdoc.