pantoken / renderers/react-markdown/src / InstuiMarkdownRenderOptions

Интерфейс: InstuiMarkdownRenderOptions ​

Бета

Параметры рендеринга, которые настраивают, как Markdown отображается в Instructure UI.

Свойства ​

optional link?: object

Бета

Поведение ссылок.

external? ​

optional external?: boolean

Показывать индикатор внешней ссылки для внешних URL (по умолчанию: 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 для доступности).