Documentation

Renders a Doc. render (Just n) will use a line length of n to reflow text on breakable spaces. render Nothing will not reflow text.

A carriage return. Does nothing if we're at the beginning of a line; otherwise inserts a newline.

Inserts a blank line unless one exists already. (blankline <> blankline has the same effect as blankline.

Inserts blank lines unless they exist already. (blanklines m <> blanklines n has the same effect as blanklines (max m n).

A breaking (reflowable) space.

A literal string.

A character.

Uses the specified string as a prefix for every line of the inside document (except the first, if not at the beginning of the line).

Makes a Doc flush against the left margin.

Indents a Doc by the specified number of spaces.

A hanging indent. hang ind start doc prints start, then doc, leaving an indent of ind spaces on every line but the first.

beforeNonBlank d conditionally includes d unless it is followed by blank space.

Makes a Doc non-reflowable.

Content to print only if it comes at the beginning of a line, to be used e.g. for escaping line-initial . in groff man.

Returns the width of a Doc.

Returns the minimal width of a Doc when reflowed at breakable spaces.

Returns the height of a block or other Doc.

lblock n d is a block of width n characters, with text derived from d and aligned to the left.

Like lblock but aligned centered.

Like lblock but aligned to the right.

An associative operation.

(a <> b) <> c = a <> (b <> c)

If a is also a Monoid we further require

(<>) = mappend

Concatenate a list of Docs, putting breakable spaces between them.

a $$ b puts a above b.

a $+$ b puts a above b, with a blank line between.

True if the document is empty.

The empty document.

Concatenate a list of Docs.

Same as cat.

Same as cat, but putting breakable spaces between the Docs.

List version of $$.

List version of $+$.

Removes leading blank lines from a Doc.

Chomps trailing blank space off of a Doc.

Encloses a Doc inside a start and end Doc.

Puts a Doc in curly braces.

Puts a Doc in square brackets.

Puts a Doc in parentheses.

Wraps a Doc in single quotes.

Wraps a Doc in double quotes.

Returns width of a character in a monospace font: 0 for a combining character, 1 for a regular character, 2 for an East Asian wide character.

Get real length of string, taking into account combining and double-wide characters.