The superdoc package

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.



This package extends Cabal's documentation building capabilities. It extends the Haddock markup language with syntax for subscripts, superscripts, bold text, non-breaking spaces, and images. Moreover, it works around various bugs in Haddock's and HsColour's Unicode support, making it possible to use UTF8 encodings in both source code and documentation comments.

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.


Change logChangeLog
Dependenciesbase (>=4.5 && <5), Cabal (>=1.16), containers (>=0.4), directory (>=1.1), filepath (>=1.3), superdoc [details]
CopyrightCopyright (c) 2013-2016 Peter Selinger
AuthorPeter Selinger
Home page
UploadedWed Jul 27 14:20:12 UTC 2016 by PeterSelinger




Maintainers' corner

For package maintainers and hackage trustees