Documentation DSL for persistent entities

LTS Haskell 19.8:
Stackage Nightly 2022-05-27:
Latest on Hackage:

See all snapshots persistent-documentation appears in

Apache-2.0 licensed by parsonsmatt
Maintained by
This version can be pinned in stack with:persistent-documentation-,1474

Module documentation for


Hackage-Deps Build Status

This library provides a DSL for attaching documentation to persistent entities as well as rendering documentation.

For an example, check out the test suite, and the rendered example.


Revision history for persistent-documentation

  • Replace newlines with line breaks in field comments as rendered by markdownTableRenderer #9

  • Support persistent-2.12 and persistent-2.13. #4

  • Support persistent- #3

  • Document use of the mkEntityDefList to expose the [EntityDef] generated by the Persistent QuasiQuoter instead of using the QQ value directly. – YYYY-mm-dd

  • First version. Released on an unsuspecting world.