Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Markdown overview

Added in v0.6.0


Table of contents


constructors

Bold

Signature

export declare const Bold: (content: Markdown) => Markdown

Added in v0.6.0

Fence

Signature

export declare const Fence: (language: string, content: Markdown) => Markdown

Added in v0.6.0

Signature

export declare const Header: (level: number, content: Markdown) => Markdown

Added in v0.6.0

Newline

Signature

export declare const Newline: Markdown

Added in v0.6.0

Paragraph

Signature

export declare const Paragraph: (content: Markdown) => Markdown

Added in v0.6.0

PlainText

Signature

export declare const PlainText: (content: string) => Markdown

Added in v0.6.0

PlainTexts

Signature

export declare const PlainTexts: (content: ReadonlyArray<Markdown>) => Markdown

Added in v0.6.0

Strikethrough

Signature

export declare const Strikethrough: (content: Markdown) => Markdown

Added in v0.6.0

destructors

fold

Signature

export declare const fold: <R>(patterns: {
  readonly Bold: (content: Markdown) => R
  readonly Fence: (language: string, content: Markdown) => R
  readonly Header: (level: number, content: Markdown) => R
  readonly Newline: () => R
  readonly Paragraph: (content: Markdown) => R
  readonly PlainText: (content: string) => R
  readonly PlainTexts: (content: ReadonlyArray<Markdown>) => R
  readonly Strikethrough: (content: Markdown) => R
}) => (markdown: Markdown) => R

Added in v0.6.0

instances

monoidMarkdown

Signature

export declare const monoidMarkdown: M.Monoid<Markdown>

Added in v0.6.0

semigroupMarkdown

Signature

export declare const semigroupMarkdown: Semigroup<Markdown>

Added in v0.6.0

showMarkdown

Signature

export declare const showMarkdown: Show<Markdown>

Added in v0.6.0

model

Bold (interface)

Signature

export interface Bold {
  readonly _tag: 'Bold'
  readonly content: Markdown
}

Added in v0.6.0

Fence (interface)

Signature

export interface Fence {
  readonly _tag: 'Fence'
  readonly language: string
  readonly content: Markdown
}

Added in v0.6.0

Header (interface)

Signature

export interface Header {
  readonly _tag: 'Header'
  readonly level: number
  readonly content: Markdown
}

Added in v0.6.0

Markdown (type alias)

Signature

export type Markdown = Bold | Fence | Header | Newline | Paragraph | PlainText | PlainTexts | Strikethrough

Added in v0.6.0

Newline (interface)

Signature

export interface Newline {
  readonly _tag: 'Newline'
}

Added in v0.6.0

Paragraph (interface)

Signature

export interface Paragraph {
  readonly _tag: 'Paragraph'
  readonly content: Markdown
}

Added in v0.6.0

PlainText (interface)

Signature

export interface PlainText {
  readonly _tag: 'PlainText'
  readonly content: string
}

Added in v0.6.0

PlainTexts (interface)

Signature

export interface PlainTexts {
  readonly _tag: 'PlainTexts'
  readonly content: ReadonlyArray<Markdown>
}

Added in v0.6.0

Printable (type alias)

Signature

export type Printable = Class | Constant | Export | Function | Interface | TypeAlias

Added in v0.6.0

Strikethrough (interface)

Signature

export interface Strikethrough {
  readonly _tag: 'Strikethrough'
  readonly content: Markdown
}

Added in v0.6.0

printers

printClass

Signature

export declare const printClass: (c: Class) => string

Added in v0.6.0

printConstant

Signature

export declare const printConstant: (c: Constant) => string

Added in v0.6.0

printExport

Signature

export declare const printExport: (e: Export) => string

Added in v0.6.0

printFunction

Signature

export declare const printFunction: (f: Function) => string

Added in v0.6.0

printInterface

Signature

export declare const printInterface: (i: Interface) => string

Added in v0.6.0

printModule

Signature

export declare const printModule: (module: Module, order: number) => string

Added in v0.6.0

printTypeAlias

Signature

export declare const printTypeAlias: (f: TypeAlias) => string

Added in v0.6.0