superdoc: Additional documentation markup and Unicode support

[ bsd3, distribution, library ] [ Propose Tags ]

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.

Versions [faq],,,,,,,,,,,
Change log ChangeLog
Dependencies base (>=4.6 && <4.9), Cabal (>=1.16), containers (>=0.5), directory (>=1.2), filepath (>=1.3), superdoc [details]
License BSD-3-Clause
Copyright Copyright (c) 2013-2015 Peter Selinger
Author Peter Selinger
Category Distribution
Home page
Uploaded by PeterSelinger at Sat Aug 15 13:07:20 UTC 2015
Distributions NixOS:
Executables superdoc-armor
Downloads 3728 total (169 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]




Maintainer's Corner

For package maintainers and hackage trustees