Markdown

Die Markdown Component rendert Texteingaben im Markdown-Format.GitHubMarkdown

Properties

PropertyTypeDescription
color
defaultdarklightdark-staticlight-staticDefault: "default"
The color schema of the markdown component.
headingOffset
numberDefault: 0
Shifts all heading levels by the given offset.
components
Components
Allows overriding markdown element renderers from outside.
ref
Ref<HTMLDivElement>
className
string
The elements class name.
children
ReactNode
Markdown.
allowElement
AllowElement
Filter elements (optional); `allowedElements` / `disallowedElements` is used first.
allowedElements
readonly string[]
Tag names to allow (default: all tag names); cannot combine w/ `disallowedElements`.
disallowedElements
readonly string[]
Tag names to disallow (default: `[]`); cannot combine w/ `allowedElements`.
rehypePlugins
PluggableList
List of rehype plugins to use.
remarkPlugins
PluggableList
List of remark plugins to use.
remarkRehypeOptions
Readonly<Options>
Options to pass through to `remark-rehype`.
skipHtml
boolean
Ignore HTML in markdown completely (default: `false`).
unwrapDisallowed
boolean
Extract (unwrap) what’s in disallowed elements (default: `false`); normally when say `strong` is not allowed, it and it’s children are dropped, with `unwrapDisallowed` the element itself is replaced by its children.
urlTransform
UrlTransform
Change URLs (default: `defaultUrlTransform`)

Auf dieser Seite