Skip to content

pantoken-root / renderers/react-markdown/src / InstuiMarkdownRenderOptions

Interface: InstuiMarkdownRenderOptions ​

Bêta

Options de rendu qui ajustent la manière dont Markdown se mappe sur Instructure UI.

Propriétés ​

optional link?: object

Bêta

Comportement des liens.

external? ​

optional external?: boolean

Afficher une indication de lien externe sur les liens hors site (par défaut : true).

optional permalinks?: boolean

Ajouter des ancres de permalien aux titres (par défaut : false).

permalinkClassName? ​

optional permalinkClassName?: string

Nom de classe pour les ancres de permalien (par défaut : pantoken-heading-anchor).


code? ​

optional code?: object

Bêta

Comportement des blocs de code délimités (fenced).

language? ​

optional language?: boolean

Conserver l'indice de langage comme attribut data-language (par défaut : true).


icons? ​

optional icons?: object

Bêta

Comportement du token inline :icon:.

enabled? ​

optional enabled?: boolean

Activer le rendu :icon: (par défaut : true).

color? ​

optional color?: string

Couleur CSS appliquée aux icônes rendues.

resolvers? ​

optional resolvers?: IconResolver[]

Résolveurs supplémentaires, essayés avant l'ensemble d'icônes pantoken intégré.

plugins? ​

optional plugins?: PantokenPlugin[]

Plugins dont les hooks rehype fournissent des résolveurs (par ex. simple-icons).


color? ​

optional color?: object

Bêta

Échantillons de couleur en ligne (par ex. #03893D).

enabled? ​

optional enabled?: boolean

Activer les échantillons de couleur (par défaut : true).


alerts? ​

optional alerts?: object

Bêta

Alertes en bloc de style GitHub (blockquote).

enabled? ​

optional enabled?: boolean

Activer le mappage > [!NOTE] → InstUI Alert (par défaut : true).


tableCaption? ​

optional tableCaption?: string

Bêta

Légende utilisée pour les tableaux rendus (requise par InstUI Table pour l'accessibilité).