Skip to content

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

Eksperymentalne

@pantoken/markdown-it — wtyczka do markdown-it, która renderuje kody :icon: jako osadzone SVG oraz samodzielne wartości kolorów (#03893D, rgb(…), oklch(…)) jako próbki kolorów, używając zestawu ikon pantoken.

Przenosi potoki @pantoken/rehype i @pantoken/react-markdown na markdown-it: jedna reguła rdzeniowa przechodzi po tekście każdego tokena inline, dzieli go według wzorców ikon i kolorów oraz zamienia dopasowania na tokeny html_inline. Kody ikon rozwiązywane są przez łańcuch — najpierw resolvery wtyczek rehype, następnie jawny MarkdownItOptions.resolve, a na końcu wbudowany zestaw @pantoken/icons — dzięki temu wtyczki brand-icon komponują się tak samo jak w innych miejscach.

Wygenerowany znacznik używa tych samych nazw klas co inne renderery (pantoken-icon, pantoken-color-swatch), więc załadowanie styli @pantoken/components je wystylizuje. Owiń wyrenderowany HTML w kontener .pantoken-prose (patrz PROSE_CLASS), aby również zastosować warstwę prose.

Przykład ​

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.");

Interfejsy ​

Zmienne ​

Funkcje ​

Odwołania ​

default ​

Zmienia nazwę i ponownie eksportuje pantokenMarkdownIt