@shikijs/markdown-it 2.0.3 → 2.2.0

package/dist/async.d.mts

@@ -0,0 +1,14 @@
+import { MarkdownItAsync } from 'markdown-it-async';
+import { CodeToHastOptions } from 'shiki';
+import { M as MarkdownItShikiSetupOptions } from './shared/markdown-it.BMSlR5u0.mjs';
+export { a as MarkdownItShikiExtraOptions } from './shared/markdown-it.BMSlR5u0.mjs';
+
+declare function setupMarkdownWithCodeToHtml(markdownit: MarkdownItAsync, codeToHtml: (code: string, options: CodeToHastOptions<any, any>) => Promise<string>, options: MarkdownItShikiSetupOptions): void;
+/**
+ * Create a markdown-it-async plugin from a codeToHtml function.
+ *
+ * This plugin requires to be installed against a markdown-it-async instance.
+ */
+declare function fromAsyncCodeToHtml(codeToHtml: (code: string, options: CodeToHastOptions<any, any>) => Promise<string>, options: MarkdownItShikiSetupOptions): (markdownit: MarkdownItAsync) => Promise<void>;
+
+export { MarkdownItShikiSetupOptions, fromAsyncCodeToHtml, setupMarkdownWithCodeToHtml };

package/dist/async.d.ts

@@ -0,0 +1,14 @@
+import { MarkdownItAsync } from 'markdown-it-async';
+import { CodeToHastOptions } from 'shiki';
+import { M as MarkdownItShikiSetupOptions } from './shared/markdown-it.BMSlR5u0.js';
+export { a as MarkdownItShikiExtraOptions } from './shared/markdown-it.BMSlR5u0.js';
+
+declare function setupMarkdownWithCodeToHtml(markdownit: MarkdownItAsync, codeToHtml: (code: string, options: CodeToHastOptions<any, any>) => Promise<string>, options: MarkdownItShikiSetupOptions): void;
+/**
+ * Create a markdown-it-async plugin from a codeToHtml function.
+ *
+ * This plugin requires to be installed against a markdown-it-async instance.
+ */
+declare function fromAsyncCodeToHtml(codeToHtml: (code: string, options: CodeToHastOptions<any, any>) => Promise<string>, options: MarkdownItShikiSetupOptions): (markdownit: MarkdownItAsync) => Promise<void>;
+
+export { MarkdownItShikiSetupOptions, fromAsyncCodeToHtml, setupMarkdownWithCodeToHtml };

package/dist/async.mjs

@@ -0,0 +1,50 @@
+function setupMarkdownWithCodeToHtml(markdownit, codeToHtml, options) {
+  const {
+    parseMetaString,
+    trimEndingNewline = true,
+    defaultLanguage = "text"
+  } = options;
+  markdownit.options.highlight = async (code, lang = "text", attrs) => {
+    if (lang === "") {
+      lang = defaultLanguage;
+    }
+    const meta = parseMetaString?.(attrs, code, lang) || {};
+    const codeOptions = {
+      ...options,
+      lang,
+      meta: {
+        ...options.meta,
+        ...meta,
+        __raw: attrs
+      }
+    };
+    const builtInTransformer = [];
+    builtInTransformer.push({
+      name: "@shikijs/markdown-it:block-class",
+      code(node) {
+        node.properties.class = `language-${lang}`;
+      }
+    });
+    if (trimEndingNewline) {
+      if (code.endsWith("\n"))
+        code = code.slice(0, -1);
+    }
+    return await codeToHtml(
+      code,
+      {
+        ...codeOptions,
+        transformers: [
+          ...builtInTransformer,
+          ...codeOptions.transformers || []
+        ]
+      }
+    );
+  };
+}
+function fromAsyncCodeToHtml(codeToHtml, options) {
+  return async function(markdownit) {
+    return setupMarkdownWithCodeToHtml(markdownit, codeToHtml, options);
+  };
+}
+
+export { fromAsyncCodeToHtml, setupMarkdownWithCodeToHtml };

package/dist/core.d.mts

@@ -1,34 +1,9 @@
 import MarkdownIt from 'markdown-it';
-import { LanguageInput, BuiltinLanguage, CodeOptionsThemes, BuiltinTheme, TransformerOptions, CodeOptionsMeta, HighlighterGeneric } from 'shiki';
+import { HighlighterGeneric } from 'shiki';
+import { M as MarkdownItShikiSetupOptions } from './shared/markdown-it.BMSlR5u0.mjs';
+export { a as MarkdownItShikiExtraOptions } from './shared/markdown-it.BMSlR5u0.mjs';
 
-interface MarkdownItShikiExtraOptions {
-    /**
-     * Custom meta string parser
-     * Return an object to merge with `meta`
-     */
-    parseMetaString?: (metaString: string, code: string, lang: string) => Record<string, any> | undefined | null;
-    /**
-     * markdown-it's highlight function will add a trailing newline to the code.
-     *
-     * This integration removes the trailing newline to the code by default,
-     * you can turn this off by passing false.
-     *
-     * @default true
-     */
-    trimEndingNewline?: boolean;
-    /**
-     * When lang of code block is empty string, it will work.
-     *
-     * @default 'text'
-     */
-    defaultLanguage?: LanguageInput | BuiltinLanguage;
-    /**
-     * When lang of code block is not included in langs of options, it will be as a fallback lang.
-     */
-    fallbackLanguage?: LanguageInput | BuiltinLanguage;
-}
-type MarkdownItShikiSetupOptions = CodeOptionsThemes<BuiltinTheme> & TransformerOptions & CodeOptionsMeta & MarkdownItShikiExtraOptions;
 declare function setupMarkdownIt(markdownit: MarkdownIt, highlighter: HighlighterGeneric<any, any>, options: MarkdownItShikiSetupOptions): void;
 declare function fromHighlighter(highlighter: HighlighterGeneric<any, any>, options: MarkdownItShikiSetupOptions): (markdownit: MarkdownIt) => void;
 
-export { type MarkdownItShikiExtraOptions, type MarkdownItShikiSetupOptions, fromHighlighter, setupMarkdownIt };
+export { MarkdownItShikiSetupOptions, fromHighlighter, setupMarkdownIt };

package/dist/core.d.ts

@@ -1,34 +1,9 @@
 import MarkdownIt from 'markdown-it';
-import { LanguageInput, BuiltinLanguage, CodeOptionsThemes, BuiltinTheme, TransformerOptions, CodeOptionsMeta, HighlighterGeneric } from 'shiki';
+import { HighlighterGeneric } from 'shiki';
+import { M as MarkdownItShikiSetupOptions } from './shared/markdown-it.BMSlR5u0.js';
+export { a as MarkdownItShikiExtraOptions } from './shared/markdown-it.BMSlR5u0.js';
 
-interface MarkdownItShikiExtraOptions {
-    /**
-     * Custom meta string parser
-     * Return an object to merge with `meta`
-     */
-    parseMetaString?: (metaString: string, code: string, lang: string) => Record<string, any> | undefined | null;
-    /**
-     * markdown-it's highlight function will add a trailing newline to the code.
-     *
-     * This integration removes the trailing newline to the code by default,
-     * you can turn this off by passing false.
-     *
-     * @default true
-     */
-    trimEndingNewline?: boolean;
-    /**
-     * When lang of code block is empty string, it will work.
-     *
-     * @default 'text'
-     */
-    defaultLanguage?: LanguageInput | BuiltinLanguage;
-    /**
-     * When lang of code block is not included in langs of options, it will be as a fallback lang.
-     */
-    fallbackLanguage?: LanguageInput | BuiltinLanguage;
-}
-type MarkdownItShikiSetupOptions = CodeOptionsThemes<BuiltinTheme> & TransformerOptions & CodeOptionsMeta & MarkdownItShikiExtraOptions;
 declare function setupMarkdownIt(markdownit: MarkdownIt, highlighter: HighlighterGeneric<any, any>, options: MarkdownItShikiSetupOptions): void;
 declare function fromHighlighter(highlighter: HighlighterGeneric<any, any>, options: MarkdownItShikiSetupOptions): (markdownit: MarkdownIt) => void;
 
-export { type MarkdownItShikiExtraOptions, type MarkdownItShikiSetupOptions, fromHighlighter, setupMarkdownIt };
+export { MarkdownItShikiSetupOptions, fromHighlighter, setupMarkdownIt };

package/dist/index.d.mts

@@ -1,7 +1,8 @@
 import MarkdownIt from 'markdown-it';
 import { LanguageInput, BuiltinLanguage } from 'shiki';
-import { MarkdownItShikiSetupOptions } from './core.mjs';
-export { MarkdownItShikiExtraOptions, fromHighlighter, setupMarkdownIt } from './core.mjs';
+import { M as MarkdownItShikiSetupOptions } from './shared/markdown-it.BMSlR5u0.mjs';
+export { a as MarkdownItShikiExtraOptions } from './shared/markdown-it.BMSlR5u0.mjs';
+export { fromHighlighter, setupMarkdownIt } from './core.mjs';
 
 type MarkdownItShikiOptions = MarkdownItShikiSetupOptions & {
     /**

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import MarkdownIt from 'markdown-it';
 import { LanguageInput, BuiltinLanguage } from 'shiki';
-import { MarkdownItShikiSetupOptions } from './core.js';
-export { MarkdownItShikiExtraOptions, fromHighlighter, setupMarkdownIt } from './core.js';
+import { M as MarkdownItShikiSetupOptions } from './shared/markdown-it.BMSlR5u0.js';
+export { a as MarkdownItShikiExtraOptions } from './shared/markdown-it.BMSlR5u0.js';
+export { fromHighlighter, setupMarkdownIt } from './core.js';
 
 type MarkdownItShikiOptions = MarkdownItShikiSetupOptions & {
     /**

package/dist/shared/markdown-it.BMSlR5u0.d.mts

@@ -0,0 +1,31 @@
+import { LanguageInput, BuiltinLanguage, CodeOptionsThemes, BuiltinTheme, TransformerOptions, CodeOptionsMeta } from 'shiki';
+
+interface MarkdownItShikiExtraOptions {
+    /**
+     * Custom meta string parser
+     * Return an object to merge with `meta`
+     */
+    parseMetaString?: (metaString: string, code: string, lang: string) => Record<string, any> | undefined | null;
+    /**
+     * markdown-it's highlight function will add a trailing newline to the code.
+     *
+     * This integration removes the trailing newline to the code by default,
+     * you can turn this off by passing false.
+     *
+     * @default true
+     */
+    trimEndingNewline?: boolean;
+    /**
+     * When lang of code block is empty string, it will work.
+     *
+     * @default 'text'
+     */
+    defaultLanguage?: LanguageInput | BuiltinLanguage;
+    /**
+     * When lang of code block is not included in langs of options, it will be as a fallback lang.
+     */
+    fallbackLanguage?: LanguageInput | BuiltinLanguage;
+}
+type MarkdownItShikiSetupOptions = CodeOptionsThemes<BuiltinTheme> & TransformerOptions & CodeOptionsMeta & MarkdownItShikiExtraOptions;
+
+export type { MarkdownItShikiSetupOptions as M, MarkdownItShikiExtraOptions as a };

package/dist/shared/markdown-it.BMSlR5u0.d.ts

@@ -0,0 +1,31 @@
+import { LanguageInput, BuiltinLanguage, CodeOptionsThemes, BuiltinTheme, TransformerOptions, CodeOptionsMeta } from 'shiki';
+
+interface MarkdownItShikiExtraOptions {
+    /**
+     * Custom meta string parser
+     * Return an object to merge with `meta`
+     */
+    parseMetaString?: (metaString: string, code: string, lang: string) => Record<string, any> | undefined | null;
+    /**
+     * markdown-it's highlight function will add a trailing newline to the code.
+     *
+     * This integration removes the trailing newline to the code by default,
+     * you can turn this off by passing false.
+     *
+     * @default true
+     */
+    trimEndingNewline?: boolean;
+    /**
+     * When lang of code block is empty string, it will work.
+     *
+     * @default 'text'
+     */
+    defaultLanguage?: LanguageInput | BuiltinLanguage;
+    /**
+     * When lang of code block is not included in langs of options, it will be as a fallback lang.
+     */
+    fallbackLanguage?: LanguageInput | BuiltinLanguage;
+}
+type MarkdownItShikiSetupOptions = CodeOptionsThemes<BuiltinTheme> & TransformerOptions & CodeOptionsMeta & MarkdownItShikiExtraOptions;
+
+export type { MarkdownItShikiSetupOptions as M, MarkdownItShikiExtraOptions as a };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/markdown-it",
   "type": "module",
-  "version": "2.0.3",
+  "version": "2.2.0",
   "description": "markdown-it integration for shiki",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -25,6 +25,10 @@
     "./core": {
       "types": "./dist/core.d.mts",
       "default": "./dist/core.mjs"
+    },
+    "./async": {
+      "types": "./dist/async.d.mts",
+      "default": "./dist/async.mjs"
     }
   },
   "main": "./dist/index.mjs",
@@ -35,6 +39,9 @@
       "core": [
         "./dist/core.d.mts"
       ],
+      "async": [
+        "./dist/async.d.mts"
+      ],
       "*": [
         "./dist/*",
         "./*"
@@ -44,13 +51,22 @@
   "files": [
     "dist"
   ],
+  "peerDependencies": {
+    "markdown-it-async": "^2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "markdown-it-async": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "markdown-it": "^14.1.0",
-    "shiki": "2.0.3"
+    "shiki": "2.2.0"
   },
   "devDependencies": {
     "@types/markdown-it": "^14.1.2",
-    "@shikijs/transformers": "2.0.3"
+    "markdown-it-async": "^2.0.0",
+    "@shikijs/transformers": "2.2.0"
   },
   "scripts": {
     "build": "unbuild",