carta/api/utilities/__data.json

{"type":"data","nodes":[null,{"type":"data","data":[{"content":1,"metadata":6},{"html":2,"css":3,"head":4},"\u003Ch2 id=\"cartarender\" data-svelte-h=\"svelte-1y6zwes\">\u003Ca href=\"#cartarender\">\u003Ccode>Carta.render\u003C/code>\u003C/a>\u003C/h2> \u003Cp data-svelte-h=\"svelte-op5yrc\">Allows you to render Markdown asynchronously.\u003C/p> \u003Cpre class=\"language-ts\">\u003C!-- HTML_TAG_START -->\u003Ccode class=\"language-ts\">\u003Cspan class=\"token keyword\">const\u003C/span> carta \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token keyword\">new\u003C/span> \u003Cspan class=\"token class-name\">Carta\u003C/span>\u003Cspan class=\"token punctuation\">(\u003C/span>\u003Cspan class=\"token punctuation\">{\u003C/span>\n\t\u003Cspan class=\"token comment\">/* ... */\u003C/span>\n\u003Cspan class=\"token punctuation\">}\u003C/span>\u003Cspan class=\"token punctuation\">)\u003C/span>\u003Cspan class=\"token punctuation\">;\u003C/span>\n\u003Cspan class=\"token keyword\">const\u003C/span> markdown \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token string\">'# Some Markdown'\u003C/span>\u003Cspan class=\"token punctuation\">;\u003C/span>\n\u003Cspan class=\"token keyword\">const\u003C/span> html \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token keyword\">await\u003C/span> carta\u003Cspan class=\"token punctuation\">.\u003C/span>\u003Cspan class=\"token function\">render\u003C/span>\u003Cspan class=\"token punctuation\">(\u003C/span>markdown\u003Cspan class=\"token punctuation\">)\u003C/span>\u003Cspan class=\"token punctuation\">;\u003C/span>\u003C/code>\u003C!-- HTML_TAG_END -->\u003C/pre> \u003Ch2 id=\"cartarenderssr\" data-svelte-h=\"svelte-1529vv2\">\u003Ca href=\"#cartarenderssr\">\u003Ccode>Carta.renderSSR\u003C/code>\u003C/a>\u003C/h2> \u003Cp data-svelte-h=\"svelte-1p2jyea\">Allows you to render Markdown synchronously, suitable for Server Side Rendering. Note that particular extensions that add content asynchronously will not work in this configuration.\u003C/p> \u003Cpre class=\"language-ts\">\u003C!-- HTML_TAG_START -->\u003Ccode class=\"language-ts\">\u003Cspan class=\"token keyword\">const\u003C/span> carta \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token keyword\">new\u003C/span> \u003Cspan class=\"token class-name\">Carta\u003C/span>\u003Cspan class=\"token punctuation\">(\u003C/span>\u003Cspan class=\"token punctuation\">{\u003C/span>\n\t\u003Cspan class=\"token comment\">/* ... */\u003C/span>\n\u003Cspan class=\"token punctuation\">}\u003C/span>\u003Cspan class=\"token punctuation\">)\u003C/span>\u003Cspan class=\"token punctuation\">;\u003C/span>\n\u003Cspan class=\"token keyword\">const\u003C/span> markdown \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token string\">'# Some Markdown'\u003C/span>\u003Cspan class=\"token punctuation\">;\u003C/span>\n\u003Cspan class=\"token keyword\">const\u003C/span> html \u003Cspan class=\"token operator\">=\u003C/span> carta\u003Cspan class=\"token punctuation\">.\u003C/span>\u003Cspan class=\"token function\">renderSSR\u003C/span>\u003Cspan class=\"token punctuation\">(\u003C/span>markdown\u003Cspan class=\"token punctuation\">)\u003C/span>\u003Cspan class=\"token punctuation\">;\u003C/span>\u003C/code>\u003C!-- HTML_TAG_END -->\u003C/pre> \u003Ch2 id=\"cartabindtocaret\" data-svelte-h=\"svelte-14p8c6l\">\u003Ca href=\"#cartabindtocaret\">\u003Ccode>Carta.bindToCaret\u003C/code>\u003C/a>\u003C/h2> \u003Cp data-svelte-h=\"svelte-w29tmn\">Svelte action that allows you to bind a specific element to the caret position. Used, for example, in \u003Ccode>plugin-emoji\u003C/code> and \u003Ccode>plugin-slash\u003C/code>.\u003C/p> \u003Cpre class=\"language-svelte\">\u003C!-- HTML_TAG_START -->\u003Ccode class=\"language-svelte\">\u003Cspan class=\"token tag\">\u003Cspan class=\"token tag\">\u003Cspan class=\"token punctuation\"><\u003C/span>script\u003C/span>\u003Cspan class=\"token punctuation\">>\u003C/span>\u003C/span>\u003Cspan class=\"token script\">\u003Cspan class=\"token language-javascript\">\n\t\u003Cspan class=\"token keyword\">export\u003C/span> \u003Cspan class=\"token keyword\">let\u003C/span> carta\u003Cspan class=\"token punctuation\">;\u003C/span>\n\u003C/span>\u003C/span>\u003Cspan class=\"token tag\">\u003Cspan class=\"token tag\">\u003Cspan class=\"token punctuation\"></\u003C/span>script\u003C/span>\u003Cspan class=\"token punctuation\">>\u003C/span>\u003C/span>\n\n\u003Cspan class=\"token tag\">\u003Cspan class=\"token tag\">\u003Cspan class=\"token punctuation\"><\u003C/span>div\u003C/span> \u003Cspan class=\"token attr-name\">\u003Cspan class=\"token namespace\">use:\u003C/span>carta.bindToCaret\u003C/span>\u003Cspan class=\"token punctuation\">>\u003C/span>\u003C/span>\n\t\u003Cspan class=\"token comment\"><!-- ... -->\u003C/span>\n\u003Cspan class=\"token tag\">\u003Cspan class=\"token tag\">\u003Cspan class=\"token punctuation\"></\u003C/span>div\u003C/span>\u003Cspan class=\"token punctuation\">>\u003C/span>\u003C/span>\u003C/code>\u003C!-- HTML_TAG_END -->\u003C/pre> \u003Ch2 id=\"cartahighlighter\" data-svelte-h=\"svelte-1h3kenj\">\u003Ca href=\"#cartahighlighter\">\u003Ccode>Carta.highlighter\u003C/code>\u003C/a>\u003C/h2> \u003Cp data-svelte-h=\"svelte-oehzko\">Get the Shiki highlighter.\u003C/p> \u003Cpre class=\"language-ts\">\u003C!-- HTML_TAG_START -->\u003Ccode class=\"language-ts\">\u003Cspan class=\"token keyword\">const\u003C/span> highlighter \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token keyword\">await\u003C/span> carta\u003Cspan class=\"token punctuation\">.\u003C/span>\u003Cspan class=\"token function\">highlighter\u003C/span>\u003Cspan class=\"token punctuation\">(\u003C/span>\u003Cspan class=\"token punctuation\">)\u003C/span>\u003Cspan class=\"token punctuation\">;\u003C/span>\n\u003Cspan class=\"token keyword\">const\u003C/span> userTheme \u003Cspan class=\"token operator\">=\u003C/span> carta\u003Cspan class=\"token punctuation\">.\u003C/span>theme\u003Cspan class=\"token punctuation\">;\u003C/span>\u003C/code>\u003C!-- HTML_TAG_END -->\u003C/pre> \u003Cp data-svelte-h=\"svelte-nxat9v\">Here are some other highlight related utilities:\u003C/p> \u003Ch3 id=\"isbundlelanguage\" data-svelte-h=\"svelte-106ufid\">\u003Ca href=\"#isbundlelanguage\">\u003Ccode>isBundleLanguage\u003C/code>\u003C/a>\u003C/h3> \u003Cp data-svelte-h=\"svelte-19545xu\">Checks if a language is a bundled language.\u003C/p> \u003Cpre class=\"language-ts\">\u003C!-- HTML_TAG_START -->\u003Ccode class=\"language-ts\">\u003Cspan class=\"token keyword\">export\u003C/span> \u003Cspan class=\"token keyword\">const\u003C/span> isBundleLanguage \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token punctuation\">(\u003C/span>lang\u003Cspan class=\"token operator\">:\u003C/span> \u003Cspan class=\"token builtin\">string\u003C/span>\u003Cspan class=\"token punctuation\">)\u003C/span>\u003Cspan class=\"token operator\">:\u003C/span> lang \u003Cspan class=\"token keyword\">is\u003C/span> BundledLanguage\u003Cspan class=\"token punctuation\">;\u003C/span>\u003C/code>\u003C!-- HTML_TAG_END -->\u003C/pre> \u003Ch3 id=\"isbundletheme\" data-svelte-h=\"svelte-19a852s\">\u003Ca href=\"#isbundletheme\">\u003Ccode>isBundleTheme\u003C/code>\u003C/a>\u003C/h3> \u003Cp data-svelte-h=\"svelte-zym92i\">Checks if a theme is a bundled theme.\u003C/p> \u003Cpre class=\"language-ts\">\u003C!-- HTML_TAG_START -->\u003Ccode class=\"language-ts\">\u003Cspan class=\"token keyword\">export\u003C/span> \u003Cspan class=\"token keyword\">const\u003C/span> isBundleTheme \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token punctuation\">(\u003C/span>theme\u003Cspan class=\"token operator\">:\u003C/span> \u003Cspan class=\"token builtin\">string\u003C/span>\u003Cspan class=\"token punctuation\">)\u003C/span>\u003Cspan class=\"token operator\">:\u003C/span> theme \u003Cspan class=\"token keyword\">is\u003C/span> BundledTheme\u003Cspan class=\"token punctuation\">;\u003C/span>\u003C/code>\u003C!-- HTML_TAG_END -->\u003C/pre> \u003Ch3 id=\"isdualtheme\" data-svelte-h=\"svelte-1l7epkq\">\u003Ca href=\"#isdualtheme\">\u003Ccode>isDualTheme\u003C/code>\u003C/a>\u003C/h3> \u003Cp data-svelte-h=\"svelte-1kj1hvu\">Checks if a theme is a dual theme.\u003C/p> \u003Cpre class=\"language-ts\">\u003C!-- HTML_TAG_START -->\u003Ccode class=\"language-ts\">\u003Cspan class=\"token keyword\">export\u003C/span> \u003Cspan class=\"token keyword\">const\u003C/span> isDualTheme \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token punctuation\">(\u003C/span>theme\u003Cspan class=\"token operator\">:\u003C/span> Theme \u003Cspan class=\"token operator\">|\u003C/span> DualTheme\u003Cspan class=\"token punctuation\">)\u003C/span>\u003Cspan class=\"token operator\">:\u003C/span> theme \u003Cspan class=\"token keyword\">is\u003C/span> DualTheme\u003Cspan class=\"token punctuation\">;\u003C/span>\u003C/code>\u003C!-- HTML_TAG_END -->\u003C/pre> \u003Ch3 id=\"issingletheme\" data-svelte-h=\"svelte-h5whms\">\u003Ca href=\"#issingletheme\">\u003Ccode>isSingleTheme\u003C/code>\u003C/a>\u003C/h3> \u003Cpre class=\"language-ts\">\u003C!-- HTML_TAG_START -->\u003Ccode class=\"language-ts\">\u003Cspan class=\"token keyword\">export\u003C/span> \u003Cspan class=\"token keyword\">const\u003C/span> isSingleTheme \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token punctuation\">(\u003C/span>theme\u003Cspan class=\"token operator\">:\u003C/span> Theme \u003Cspan class=\"token operator\">|\u003C/span> DualTheme\u003Cspan class=\"token punctuation\">)\u003C/span>\u003Cspan class=\"token operator\">:\u003C/span> theme \u003Cspan class=\"token keyword\">is\u003C/span> Theme\u003Cspan class=\"token punctuation\">;\u003C/span>\u003C/code>\u003C!-- HTML_TAG_END -->\u003C/pre> \u003Ch3 id=\"isthemeregistration\" data-svelte-h=\"svelte-14cn3xx\">\u003Ca href=\"#isthemeregistration\">\u003Ccode>isThemeRegistration\u003C/code>\u003C/a>\u003C/h3> \u003Cp data-svelte-h=\"svelte-2ggm5b\">Checks if a theme is a theme registration.\u003C/p> \u003Cpre class=\"language-ts\">\u003C!-- HTML_TAG_START -->\u003Ccode class=\"language-ts\">\u003Cspan class=\"token keyword\">export\u003C/span> \u003Cspan class=\"token keyword\">const\u003C/span> isThemeRegistration \u003Cspan class=\"token operator\">=\u003C/span> \u003Cspan class=\"token punctuation\">(\u003C/span>theme\u003Cspan class=\"token operator\">:\u003C/span> Theme\u003Cspan class=\"token punctuation\">)\u003C/span>\u003Cspan class=\"token operator\">:\u003C/span> theme \u003Cspan class=\"token keyword\">is\u003C/span> ThemeRegistration\u003Cspan class=\"token punctuation\">;\u003C/span>\u003C/code>\u003C!-- HTML_TAG_END -->\u003C/pre>",{"code":4,"map":5},"",null,{"section":7,"title":8},"API","Utilities"],"uses":{"url":1}}]}