pantoken-root / tools/demo/src / LiveExampleOptions

Interface: LiveExampleOptions ​

How to seam a live preview onto each @example HTML fence on matching pages.

Properties ​

match ​

match: (relativePath) => boolean

Only wrap fences on pages whose markdown-it env.relativePath matches (e.g. the CSS-API pages).

Parameters ​

relativePath ​

string

Returns ​

boolean

wrap ​

wrap: (html, flags, relativePath) => string

Build the preview block appended after each non-overlay html fence, from its markup, any -flag tokens parsed from the fence info string, and the page's env.relativePath (for locale/direction lookups).

Parameters ​

html ​

string

flags ​

Set<string>

relativePath ​

string

Returns ​

string