Text.Gemini

Contents

Description

A tiny Gemtext (text/gemini) parser.

Parses Gemtext documents from and back to Text. See the Section 5 of the Gemini Protocol specification.

Synopsis

Gemtext Types

A Gemtext document, in the form of an ordered list of GemItems.

A Gemtext item.

Constructors

GemText !Text	A regular Gemtext line. -- `GemText <Text>`
GemLink !Text !(Maybe Text)	A Gemtext link. -- `GemLink <Link> [Optional Description]`
GemHeading !Int !Text	A Gemtext heading of 3 levels max. -- `GemHeading <Level> <Text>`
GemList ![Text]	A Gemtext unordered list. -- `GemList <Lines>`
GemQuote !Text	A Gemtext quote. -- `GemQuote <Text>`
GemPre ![Text] !(Maybe Text)	A Gemtext preformat. -- `GemPre <Lines> [Optional Alt Text]`

Instances details

Show GemItem Source #
Instance details Defined in Text.Gemini Methods showsPrec :: Int -> GemItem -> ShowS # show :: GemItem -> String # showList :: [GemItem] -> ShowS #
Eq GemItem Source #
Instance details Defined in Text.Gemini Methods (==) :: GemItem -> GemItem -> Bool # (/=) :: GemItem -> GemItem -> Bool #

Decoding from Text

Parse a Gemtext file as GemDocument. The text should be supplied as an LF-ending Text.

Parse a single Gemtext line as GemItem.

The preformatted texts are regarded as GemTexts as they are strictly multiline.

Encode parsed GemDocument as a Gemtext file. The output Text uses LF-endings. Uses the encodeItem function below.

Valid prefixes are escaped before encoding.

Empty lists are ignored if given.

Encode a single parsed GemItem as Gemtext text. The output Text uses LF-endings and might be multiple lines.

Valid prefixes are escaped before encoding.

Beware that the output text doesn't end with a newline.

The spaces in GemLinks are replaced with %20 to normalize them.