pantoken / renderers/react-markdown/src / InstuiMarkdownRenderOptions

Schnittstelle: InstuiMarkdownRenderOptions ​

Beta

Renderoptionen, die steuern, wie Markdown auf Instructure UI abgebildet wird.

Eigenschaften ​

optional link?: object

Beta

Link-Verhalten.

external? ​

optional external?: boolean

Bei externen Links eine Kennzeichnung für externe Links anzeigen (Standard: true).

optional permalinks?: boolean

Permalink-Anker zu Überschriften hinzufügen (Standard: false).

permalinkClassName? ​

optional permalinkClassName?: string

Klassenname für Permalink-Anker (Standard: pantoken-heading-anchor).

code? ​

optional code?: object

Beta

Verhalten von eingerahmten Codeblöcken.

language? ​

optional language?: boolean

Den Sprachhinweis als data-language-Attribut beibehalten (Standard: true).

icons? ​

optional icons?: object

Beta

Verhalten des Inline-:icon:-Tokens.

enabled? ​

optional enabled?: boolean

:icon:-Rendering aktivieren (Standard: true).

color? ​

optional color?: string

CSS-Farbe, die auf gerenderte Symbole angewendet wird.

resolvers? ​

optional resolvers?: IconResolver[]

Zusätzliche Resolver, die vor dem integrierten pantoken-Symbolsatz versucht werden.

plugins? ​

optional plugins?: PantokenPlugin[]

Plugins, deren rehype-Hooks Resolver bereitstellen (z. B. simple-icons).

color? ​

optional color?: object

Beta

Inline-Farbmuster anzeigen (z. B. #03893D).

enabled? ​

optional enabled?: boolean

Farbmuster aktivieren (Standard: true).

alerts? ​

optional alerts?: object

Beta

Blockquote-Warnungen im GitHub-Stil.

enabled? ​

optional enabled?: boolean

> [!NOTE] → InstUI Alert-Abbildung aktivieren (Standard: true).

tableCaption? ​

optional tableCaption?: string

Beta

Beschriftung, die für gerenderte Tabellen verwendet wird (für InstUI Table a11y erforderlich).