pantoken / renderers/react-markdown/src / InstuiMarkdownRenderOptions

Interface: InstuiMarkdownRenderOptions

Beta

Render options that tune how Markdown maps onto Instructure UI.

Properties

link?

optional link?: object

Beta

Link behavior.

external?

optional external?: boolean

Show an external-link affordance on off-site links (default: true).

permalinks?

optional permalinks?: boolean

Add permalink anchors to headings (default: false).

permalinkClassName?

optional permalinkClassName?: string

Class name for permalink anchors (default: pantoken-heading-anchor).

---

code?

optional code?: object

Beta

Fenced code block behavior.

language?

optional language?: boolean

Preserve the language hint as a data-language attribute (default: true).

---

icons?

optional icons?: object

Beta

Inline :icon: token behavior.

enabled?

optional enabled?: boolean

Enable :icon: rendering (default: true).

color?

optional color?: string

CSS color applied to rendered icons.

resolvers?

optional resolvers?: IconResolver[]

Extra resolvers, tried before the built-in pantoken icon set.

plugins?

optional plugins?: PantokenPlugin[]

Plugins whose rehype hooks contribute resolvers (e.g. simple-icons).

---

color?

optional color?: object

Beta

Inline color-code swatches (e.g. #03893D).

enabled?

optional enabled?: boolean

Enable color swatches (default: true).

---

alerts?

optional alerts?: object

Beta

GitHub-style blockquote alerts.

enabled?

optional enabled?: boolean

Enable > [!NOTE] → InstUI Alert mapping (default: true).

---

tableCaption?

optional tableCaption?: string

Beta

Caption used for rendered tables (required by InstUI Table for a11y).