@astrojs/markdown-remark 4.3.1 → 5.0.0

package/dist/highlight.d.ts

@@ -1,7 +1,7 @@
 import type { Root } from 'hast';
 type Highlighter = (code: string, language: string, options?: {
     meta?: string;
-}) => string;
+}) => Promise<string>;
 /**
  * A hast utility to syntax highlight code blocks with a given syntax highlighter.
  *
@@ -11,5 +11,5 @@ type Highlighter = (code: string, language: string, options?: {
  *   A fnction which receives the code and language, and returns the HTML of a syntax
  *   highlighted `<pre>` element.
  */
-export declare function highlightCodeBlocks(tree: Root, highlighter: Highlighter): void;
+export declare function highlightCodeBlocks(tree: Root, highlighter: Highlighter): Promise<void>;
 export {};

package/dist/highlight.js

@@ -3,7 +3,8 @@ import { toText } from "hast-util-to-text";
 import { removePosition } from "unist-util-remove-position";
 import { visitParents } from "unist-util-visit-parents";
 const languagePattern = /\blanguage-(\S+)\b/;
-function highlightCodeBlocks(tree, highlighter) {
+async function highlightCodeBlocks(tree, highlighter) {
+  const nodes = [];
   visitParents(tree, { type: "element", tagName: "code" }, (node, ancestors) => {
     const parent = ancestors.at(-1);
     if (parent?.type !== "element" || parent.tagName !== "pre") {
@@ -30,15 +31,22 @@ function highlightCodeBlocks(tree, highlighter) {
     if (languageMatch?.[1] === "math") {
       return;
     }
+    nodes.push({
+      node,
+      language: languageMatch?.[1] || "plaintext",
+      parent,
+      grandParent: ancestors.at(-2)
+    });
+  });
+  for (const { node, language, grandParent, parent } of nodes) {
     const meta = node.data?.meta ?? node.properties.metastring ?? void 0;
     const code = toText(node, { whitespace: "pre" });
-    const html = highlighter(code, languageMatch?.[1] || "plaintext", { meta });
+    const html = await highlighter(code, language, { meta });
     const replacement = fromHtml(html, { fragment: true }).children[0];
     removePosition(replacement);
-    const grandParent = ancestors.at(-2);
     const index = grandParent.children.indexOf(parent);
     grandParent.children[index] = replacement;
-  });
+  }
 }
 export {
   highlightCodeBlocks

package/dist/index.d.ts

@@ -4,9 +4,7 @@ export { rehypeHeadingIds } from './rehype-collect-headings.js';
 export { remarkCollectImages } from './remark-collect-images.js';
 export { rehypePrism } from './rehype-prism.js';
 export { rehypeShiki } from './rehype-shiki.js';
-export { remarkPrism } from './remark-prism.js';
-export { remarkShiki } from './remark-shiki.js';
-export { createShikiHighlighter, replaceCssVariables, type ShikiHighlighter } from './shiki.js';
+export { createShikiHighlighter, type ShikiHighlighter } from './shiki.js';
 export * from './types.js';
 export declare const markdownConfigDefaults: Required<AstroMarkdownOptions>;
 /**

package/dist/index.js

@@ -22,9 +22,7 @@ import { rehypeHeadingIds as rehypeHeadingIds2 } from "./rehype-collect-headings
 import { remarkCollectImages as remarkCollectImages2 } from "./remark-collect-images.js";
 import { rehypePrism as rehypePrism2 } from "./rehype-prism.js";
 import { rehypeShiki as rehypeShiki2 } from "./rehype-shiki.js";
-import { remarkPrism } from "./remark-prism.js";
-import { remarkShiki } from "./remark-shiki.js";
-import { createShikiHighlighter, replaceCssVariables } from "./shiki.js";
+import { createShikiHighlighter } from "./shiki.js";
 export * from "./types.js";
 const markdownConfigDefaults = {
   syntaxHighlight: "shiki",
@@ -139,8 +137,5 @@ export {
   rehypePrism2 as rehypePrism,
   rehypeShiki2 as rehypeShiki,
   remarkCollectImages2 as remarkCollectImages,
-  remarkPrism,
-  remarkShiki,
-  replaceCssVariables,
   setVfileFrontmatter2 as setVfileFrontmatter
 };

package/dist/rehype-prism.js

@@ -1,10 +1,14 @@
 import { runHighlighterWithAstro } from "@astrojs/prism/dist/highlighter";
 import { highlightCodeBlocks } from "./highlight.js";
-const rehypePrism = () => (tree) => {
-  highlightCodeBlocks(tree, (code, language) => {
-    let { html, classLanguage } = runHighlighterWithAstro(language, code);
-    return `<pre class="${classLanguage}"><code is:raw class="${classLanguage}">${html}</code></pre>`;
-  });
+const rehypePrism = () => {
+  return async (tree) => {
+    await highlightCodeBlocks(tree, (code, language) => {
+      let { html, classLanguage } = runHighlighterWithAstro(language, code);
+      return Promise.resolve(
+        `<pre class="${classLanguage}"><code is:raw class="${classLanguage}">${html}</code></pre>`
+      );
+    });
+  };
 };
 export {
   rehypePrism

package/dist/rehype-shiki.js

@@ -5,7 +5,7 @@ const rehypeShiki = (config) => {
   return async (tree) => {
     highlighterAsync ??= createShikiHighlighter(config);
     const highlighter = await highlighterAsync;
-    highlightCodeBlocks(tree, highlighter.highlight);
+    await highlightCodeBlocks(tree, highlighter.highlight);
   };
 };
 export {

package/dist/shiki.d.ts

@@ -7,6 +7,6 @@ export interface ShikiHighlighter {
          * Raw `meta` information to be used by Shiki transformers
          */
         meta?: string;
-    }): string;
+    }): Promise<string>;
 }
 export declare function createShikiHighlighter({ langs, theme, themes, wrap, transformers, }?: ShikiConfig): Promise<ShikiHighlighter>;

package/dist/shiki.js

@@ -1,4 +1,8 @@
-import { bundledLanguages, createCssVariablesTheme, getHighlighter } from "shiki";
+import {
+  createCssVariablesTheme,
+  getHighlighter,
+  isSpecialLang
+} from "shiki";
 import { visit } from "unist-util-visit";
 const ASTRO_COLOR_REPLACEMENTS = {
   "--astro-code-foreground": "--astro-code-color-text",
@@ -19,15 +23,21 @@ async function createShikiHighlighter({
 } = {}) {
   theme = theme === "css-variables" ? cssVariablesTheme() : theme;
   const highlighter = await getHighlighter({
-    langs: langs.length ? langs : Object.keys(bundledLanguages),
+    langs: ["plaintext", ...langs],
     themes: Object.values(themes).length ? Object.values(themes) : [theme]
   });
-  const loadedLanguages = highlighter.getLoadedLanguages();
   return {
-    highlight(code, lang = "plaintext", options) {
-      if (lang !== "plaintext" && !loadedLanguages.includes(lang)) {
-        console.warn(`[Shiki] The language "${lang}" doesn't exist, falling back to "plaintext".`);
-        lang = "plaintext";
+    async highlight(code, lang = "plaintext", options) {
+      const loadedLanguages = highlighter.getLoadedLanguages();
+      if (!isSpecialLang(lang) && !loadedLanguages.includes(lang)) {
+        try {
+          await highlighter.loadLanguage(lang);
+        } catch (_err) {
+          console.warn(
+            `[Shiki] The language "${lang}" doesn't exist, falling back to "plaintext".`
+          );
+          lang = "plaintext";
+        }
       }
       const themeOptions = Object.values(themes).length ? { themes } : { theme };
       const inline = options?.inline ?? false;
@@ -109,6 +119,5 @@ function replaceCssVariables(str) {
   return str.replace(COLOR_REPLACEMENT_REGEX, (match) => ASTRO_COLOR_REPLACEMENTS[match] || match);
 }
 export {
-  createShikiHighlighter,
-  replaceCssVariables
+  createShikiHighlighter
 };

package/dist/types.d.ts

@@ -30,12 +30,6 @@ export interface AstroMarkdownOptions {
     gfm?: boolean;
     smartypants?: boolean;
 }
-export interface ImageMetadata {
-    src: string;
-    width: number;
-    height: number;
-    type: string;
-}
 export interface MarkdownProcessor {
     render: (content: string, opts?: MarkdownProcessorRenderOptions) => Promise<MarkdownProcessorRenderResult>;
 }
@@ -51,26 +45,14 @@ export interface MarkdownProcessorRenderResult {
         frontmatter: Record<string, any>;
     };
 }
-export interface MarkdownRenderingOptions extends AstroMarkdownOptions, MarkdownProcessorRenderOptions {
-}
 export interface MarkdownHeading {
     depth: number;
     slug: string;
     text: string;
 }
-export interface MarkdownMetadata {
-    headings: MarkdownHeading[];
-    source: string;
-    html: string;
-}
 export interface MarkdownVFile extends VFile {
     data: {
         __astroHeadings?: MarkdownHeading[];
         imagePaths?: Set<string>;
     };
 }
-export interface MarkdownRenderingResult {
-    metadata: MarkdownMetadata;
-    vfile: MarkdownVFile;
-    code: string;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "4.3.1",
+  "version": "5.0.0",
   "type": "module",
   "author": "withastro",
   "license": "MIT",

package/dist/remark-prism.d.ts

@@ -1,5 +0,0 @@
-import type { RemarkPlugin } from './types.js';
-/**
- * @deprecated Use `rehypePrism` instead
- */
-export declare function remarkPrism(): ReturnType<RemarkPlugin>;

package/dist/remark-prism.js

@@ -1,19 +0,0 @@
-import { runHighlighterWithAstro } from "@astrojs/prism/dist/highlighter";
-import { visit } from "unist-util-visit";
-function remarkPrism() {
-  return function(tree) {
-    visit(tree, "code", (node) => {
-      let { lang, value } = node;
-      node.type = "html";
-      let { html, classLanguage } = runHighlighterWithAstro(lang, value);
-      let classes = [classLanguage];
-      node.value = `<pre class="${classes.join(
-        " "
-      )}"><code is:raw class="${classLanguage}">${html}</code></pre>`;
-      return node;
-    });
-  };
-}
-export {
-  remarkPrism
-};

package/dist/remark-shiki.d.ts

@@ -1,5 +0,0 @@
-import type { RemarkPlugin, ShikiConfig } from './types.js';
-/**
- * @deprecated Use `rehypeShiki` instead
- */
-export declare function remarkShiki(config?: ShikiConfig): ReturnType<RemarkPlugin>;

package/dist/remark-shiki.js

@@ -1,19 +0,0 @@
-import { visit } from "unist-util-visit";
-import { createShikiHighlighter } from "./shiki.js";
-function remarkShiki(config) {
-  let highlighterAsync;
-  return async (tree) => {
-    highlighterAsync ??= createShikiHighlighter(config);
-    const highlighter = await highlighterAsync;
-    visit(tree, "code", (node) => {
-      const lang = typeof node.lang === "string" ? node.lang : "plaintext";
-      const html = highlighter.highlight(node.value, lang);
-      node.type = "html";
-      node.value = html;
-      node.children = [];
-    });
-  };
-}
-export {
-  remarkShiki
-};