Skip to content

pantoken / renderers/react-markdown/src / InstuiMarkdownRenderOptions

Інтерфейс: InstuiMarkdownRenderOptions

Бета

Параметри рендерингу, що налаштовують, як Markdown відображається в Instructure UI.

Властивості

optional link?: object

Бета

Поведінка посилань.

external?

optional external?: boolean

Показувати позначку зовнішнього посилання для зовнішніх ресурсів (за замовчуванням: true).

optional permalinks?: boolean

Додавати якірні посилання до заголовків (за замовчуванням: false).

permalinkClassName?

optional permalinkClassName?: string

Ім'я класу для якірних посилань (за замовчуванням: pantoken-heading-anchor).


code?

optional code?: object

Бета

Поведінка обрамлених блоків коду.

language?

optional language?: boolean

Зберігати підказку мови як атрибут data-language (за замовчуванням: true).


icons?

optional icons?: object

Бета

Поведінка вбудованого токена :icon:.

enabled?

optional enabled?: boolean

Увімкнути відображення :icon: (за замовчуванням: true).

color?

optional color?: string

CSS-колір, застосований до відрендерених іконок.

resolvers?

optional resolvers?: IconResolver[]

Додаткові резолвери, які перевіряються перед вбудованим набором іконок pantoken.

plugins?

optional plugins?: PantokenPlugin[]

Плагіни, чиї хуки rehype додають резолвери (наприклад, simple-icons).


color?

optional color?: object

Бета

Вбудовані зразки кольорів у коді (наприклад, #03893D).

enabled?

optional enabled?: boolean

Увімкнути зразки кольорів (за замовчуванням: true).


alerts?

optional alerts?: object

Бета

Сповіщення у стилі GitHub для блоків цитат.

enabled?

optional enabled?: boolean

Увімкнути мапінг > [!NOTE] → InstUI Alert (за замовчуванням: true).


tableCaption?

optional tableCaption?: string

Бета

Підпис, що використовується для відрендерених таблиць (потрібно InstUI Table для доступності).