pantoken-root / markdown-it

markdown-it ​

Compatibility ​

Target: markdown-it. Minimum host version: 14.0.0. Tested through 15.0.2. Newer releases require review.

Full compatibility matrix

Експериментальний

@pantoken/markdown-it — плагін для markdown-it, який рендерить коди :icon: як inline SVG і окремі значення кольорів (#03893D, rgb(…), oklch(…)) як зразки кольору, використовуючи набір іконок pantoken.

Він портує конвеєри @pantoken/rehype і @pantoken/react-markdown на markdown-it: одне ядро проходить по текстовим дочірнім токенам кожного inline-токена, розбиває їх за шаблонами іконок і кольорів і замінює збіги на токени html_inline. Коди іконок резольвляться ланцюжком — спочатку резолвери плагіна rehype, потім явний MarkdownItOptions.resolve, а потім вбудований набір @pantoken/icons — тому плагіни брендових іконок компонуються так само, як і в інших місцях.

Згенерований розмітка використовує ті самі назви класів, що й інші рендерери (pantoken-icon, pantoken-color-swatch), тому підключені стилі @pantoken/components її оформлять. Обгорніть відрендерений HTML у контейнер .pantoken-prose (див. PROSE_CLASS), щоб також підхопити шар прозового стилю.

Приклад ​

ts
import MarkdownIt from "markdown-it";
import { pantokenMarkdownIt } from "@pantoken/markdown-it";

const md = new MarkdownIt().use(pantokenMarkdownIt);
md.render("Save :check: to lock in #03893D.");

Інтерфейси ​

Змінні ​

Функції ​

Посилання ​

default ​

Перейменовує та реекспортує pantokenMarkdownIt