doclayout

doclayout is a prettyprinting library for laying out text documents, with several features not present in prettyprinting libraries designed for code. It was designed for use in pandoc.


Keywords
library, text, Propose Tags, Skip to Readme, , Index, Quick Jump, Text.DocLayout, doclayout-0.4.0.1.tar.gz, browse, Package description, Package maintainers, JohnMacFarlane, edit package information , 0.4.0.1
License
BSD-3-Clause
Install
cabal install doclayout-0.4.0.1

Documentation

doclayout

CI tests

This is a prettyprinting library designed for laying out plain-text documents. It originated in the pandoc module Text.Pandoc.Pretty, and its development has been guided by pandoc's needs in rendering wrapped textual documents.

In supports wrapping of text on breaking spaces, indentation and other line prefixes, blank lines, and tabular content.

Example:

Text.DocLayout> mydoc = hang 2 "- " (text "foo" <+> text "bar")
Text.DocLayout> putStrLn $ render (Just 20) mydoc
- foo bar
Text.DocLayout> putStrLn $ render (Just 10) (prefixed "> " (mydoc $+$ mydoc))
> - foo
>   bar
>
> - foo
>   bar

The Doc type may be parameterized to either String or (strict or lazy) Text, depending on the desired render target.