Skip to content

pantoken / renderers/react-markdown/src / InstuiMarkdownRenderOptions

接口: InstuiMarkdownRenderOptions

Beta

用于调整 Markdown 如何映射到 Instructure UI 的渲染选项。

属性

optional link?: object

Beta

链接行为。

external?

optional external?: boolean

在外部站点链接上显示外部链接标识(默认:true)。

optional permalinks?: boolean

在标题上添加永久链接锚点(默认:false)。

permalinkClassName?

optional permalinkClassName?: string

永久链接锚点的类名(默认:pantoken-heading-anchor)。


code?

optional code?: object

Beta

代码围栏块的行为。

language?

optional language?: boolean

将语言提示保留为 data-language 属性(默认:true)。


icons?

optional icons?: object

Beta

内联 :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

Beta

内联颜色样本(例如:#03893D)。

enabled?

optional enabled?: boolean

启用颜色样本(默认:true)。


alerts?

optional alerts?: object

Beta

类 GitHub 风格的引用块警示。

enabled?

optional enabled?: boolean

启用 > [!NOTE] 到 InstUI Alert 的映射(默认:true)。


tableCaption?

optional tableCaption?: string

Beta

用于渲染表格的标题(由 InstUI Table 为无障碍性要求)。