Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.Server.Doc.Markdown.Types

Synopsis

data Markdown
- = ThematicBreak
- | Paragraph [Markdown]
- | BlockQuote [Markdown]
- | CodeBlock Text Text
- | Heading Int [Markdown]
- | OrderedList Int [[Markdown]]
- | UnorderedList [[Markdown]]
- | Txt Text
- | Linebreak
- | InlineCode Text
- | Italics [Markdown]
- | Strong [Markdown]
- | Strikethrough [Markdown]
- | Link [Markdown] Text
- | Image [Markdown] Text
- | Table (Maybe [[Markdown]]) [[[Markdown]]]
toText :: [Markdown] -> Text

Documentation

data Markdown Source #

Custom type for converting Docs into Markdown. I tried using the existing cmark-gfm library for this, but we have too many edge-cases for it to work well.

Constructors

ThematicBreak	E.g. '---'
Paragraph [Markdown]
BlockQuote [Markdown]
CodeBlock Text Text
Heading Int [Markdown]
OrderedList Int [[Markdown]]
UnorderedList [[Markdown]]
Txt Text
Linebreak
InlineCode Text
Italics [Markdown]
Strong [Markdown]
Strikethrough [Markdown]
Link [Markdown] Text
Image [Markdown] Text
Table (Maybe [[Markdown]]) [[[Markdown]]]

Instances

Instances details

Show Markdown Source #
Instance details Defined in Unison.Server.Doc.Markdown.Types Methods showsPrec :: Int -> Markdown -> ShowS # show :: Markdown -> String # showList :: [Markdown] -> ShowS #

toText :: [Markdown] -> Text Source #

Render the markdown datatype to markdown text