Interface MarkupOption

MarkupOption markup options

Hierarchy

  • MarkupOption

Properties

Context? FilePath? Mode? Text? Wiki?

Properties

Optional Context

Context?: string

URL path for rendering issue, media and file links Expected format: /subpath/{user}/{repo}/src/{branch, commit, tag}/{identifier/path}/{file/dir}

in: body

Optional FilePath

FilePath?: string

File path for detecting extension in file mode

in: body

Optional Mode

Mode?: string

Mode to render (markdown, comment, wiki, file)

in: body

Optional Text

Text?: string

Text markup to render

in: body

Optional Wiki

Wiki?: boolean

Is it a wiki page? (use mode=wiki instead)

Deprecated: true in: body

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc