morley-1.7.0: Developer tools for the Michelson Language

Safe Haskell	None
Language	Haskell2010

Util.Markdown

Description

A small Markdown eDSL.

Synopsis

type Markdown = Builder
newtype HeaderLevel = HeaderLevel Int
newtype Anchor = Anchor {
- unAnchor :: Text
}
class ToAnchor anchor where
- toAnchor :: anchor -> Anchor
nextHeaderLevel :: HeaderLevel -> HeaderLevel
mdHeader :: HeaderLevel -> Markdown -> Markdown
mdToc :: ToAnchor anchor => HeaderLevel -> Markdown -> anchor -> Markdown
mdSubsection :: Markdown -> Markdown -> Markdown
mdSubsectionTitle :: Markdown -> Markdown
mdBold :: Markdown -> Markdown
mdItalic :: Markdown -> Markdown
mdTicked :: Markdown -> Markdown
mdRef :: Markdown -> Markdown -> Markdown
mdLocalRef :: ToAnchor anchor => Markdown -> anchor -> Markdown
mdEscapeAnchor :: ToAnchor anchor => anchor -> Markdown
mdAnchor :: ToAnchor anchor => anchor -> Markdown
mdSeparator :: Markdown
mdSpoiler :: Markdown -> Markdown -> Markdown
mdComment :: Builder -> Builder
md :: QuasiQuoter

Documentation

type Markdown = Builder Source #

A piece of markdown document.

This is opposed to Text type, which in turn is not supposed to contain markup elements.

newtype HeaderLevel Source #

Level of header, starting from 1.

Constructors

HeaderLevel Int

newtype Anchor Source #

Anchor with given text.

Constructors

Anchor
Fields unAnchor :: Text

Instances

Instances details

IsString Anchor Source #
Instance details Defined in Util.Markdown Methods fromString :: String -> Anchor #
ToAnchor Anchor Source #
Instance details Defined in Util.Markdown Methods toAnchor :: Anchor -> Anchor Source #

class ToAnchor anchor where Source #

Picking anchor for various things.

Methods

toAnchor :: anchor -> Anchor Source #

Instances

Instances details

ToAnchor Text Source #
Instance details Defined in Util.Markdown Methods toAnchor :: Text -> Anchor Source #
ToAnchor Anchor Source #
Instance details Defined in Util.Markdown Methods toAnchor :: Anchor -> Anchor Source #
ToAnchor DocItemId Source #
Instance details Defined in Michelson.Doc Methods toAnchor :: DocItemId -> Anchor Source #
ToAnchor (DocItemRef d 'True) Source #
Instance details Defined in Michelson.Doc Methods toAnchor :: DocItemRef d 'True -> Anchor Source #

nextHeaderLevel :: HeaderLevel -> HeaderLevel Source #

mdHeader :: HeaderLevel -> Markdown -> Markdown Source #

mdToc :: ToAnchor anchor => HeaderLevel -> Markdown -> anchor -> Markdown Source #

mdSubsection :: Markdown -> Markdown -> Markdown Source #

mdSubsectionTitle :: Markdown -> Markdown Source #

mdBold :: Markdown -> Markdown Source #

mdItalic :: Markdown -> Markdown Source #

mdTicked :: Markdown -> Markdown Source #

mdRef :: Markdown -> Markdown -> Markdown Source #

mdLocalRef :: ToAnchor anchor => Markdown -> anchor -> Markdown Source #

mdEscapeAnchor :: ToAnchor anchor => anchor -> Markdown Source #

Turn text into valid anchor. Human-readability is not preserved.

mdAnchor :: ToAnchor anchor => anchor -> Markdown Source #

mdSeparator :: Markdown Source #

mdSpoiler :: Markdown -> Markdown -> Markdown Source #

Text which is hidden until clicked.

mdComment :: Builder -> Builder Source #

md :: QuasiQuoter Source #

Quasi quoter for Markdown.

This supports interpolation via #{expression} syntax.