@astrojs/markdown-remark 6.2.1 → 6.3.0

package/dist/highlight.d.ts

@@ -2,6 +2,7 @@ import type { Root } from 'hast';
 type Highlighter = (code: string, language: string, options?: {
     meta?: string;
 }) => Promise<Root | string>;
+export declare const defaultExcludeLanguages: string[];
 /**
  * A hast utility to syntax highlight code blocks with a given syntax highlighter.
  *
@@ -11,5 +12,5 @@ type Highlighter = (code: string, language: string, options?: {
  *   A function which receives the code and language, and returns the HTML of a syntax
  *   highlighted `<pre>` element.
  */
-export declare function highlightCodeBlocks(tree: Root, highlighter: Highlighter): Promise<void>;
+export declare function highlightCodeBlocks(tree: Root, highlighter: Highlighter, excludeLanguages?: string[]): 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/;
-async function highlightCodeBlocks(tree, highlighter) {
+const defaultExcludeLanguages = ["math"];
+async function highlightCodeBlocks(tree, highlighter, excludeLanguages = []) {
   const nodes = [];
   visitParents(tree, { type: "element", tagName: "code" }, (node, ancestors) => {
     const parent = ancestors.at(-1);
@@ -28,12 +29,13 @@ async function highlightCodeBlocks(tree, highlighter) {
         }
       }
     }
-    if (languageMatch?.[1] === "math") {
+    const language = languageMatch?.[1] || "plaintext";
+    if (excludeLanguages.includes(language) || defaultExcludeLanguages.includes(language)) {
       return;
     }
     nodes.push({
       node,
-      language: languageMatch?.[1] || "plaintext",
+      language,
       parent,
       grandParent: ancestors.at(-2)
     });
@@ -54,5 +56,6 @@ async function highlightCodeBlocks(tree, highlighter) {
   }
 }
 export {
+  defaultExcludeLanguages,
   highlightCodeBlocks
 };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { AstroMarkdownOptions, AstroMarkdownProcessorOptions, MarkdownProcessor } from './types.js';
+import type { AstroMarkdownOptions, AstroMarkdownProcessorOptions, MarkdownProcessor, SyntaxHighlightConfig } from './types.js';
 export { rehypeHeadingIds } from './rehype-collect-headings.js';
 export { remarkCollectImages } from './remark-collect-images.js';
 export { rehypePrism } from './rehype-prism.js';
@@ -6,6 +6,7 @@ export { rehypeShiki } from './rehype-shiki.js';
 export { isFrontmatterValid, extractFrontmatter, parseFrontmatter, type ParseFrontmatterOptions, type ParseFrontmatterResult, } from './frontmatter.js';
 export { createShikiHighlighter, type ShikiHighlighter, type CreateShikiHighlighterOptions, type ShikiHighlighterHighlightOptions, } from './shiki.js';
 export * from './types.js';
+export declare const syntaxHighlightDefaults: Required<SyntaxHighlightConfig>;
 export declare const markdownConfigDefaults: Required<AstroMarkdownOptions>;
 /**
  * Create a markdown preprocessor to render multiple markdown files

package/dist/index.js

@@ -11,6 +11,7 @@ import remarkRehype from "remark-rehype";
 import remarkSmartypants from "remark-smartypants";
 import { unified } from "unified";
 import { VFile } from "vfile";
+import { defaultExcludeLanguages } from "./highlight.js";
 import { rehypeImages } from "./rehype-images.js";
 import { rehypeHeadingIds as rehypeHeadingIds2 } from "./rehype-collect-headings.js";
 import { remarkCollectImages as remarkCollectImages2 } from "./remark-collect-images.js";
@@ -25,8 +26,12 @@ import {
   createShikiHighlighter
 } from "./shiki.js";
 export * from "./types.js";
+const syntaxHighlightDefaults = {
+  type: "shiki",
+  excludeLangs: defaultExcludeLanguages
+};
 const markdownConfigDefaults = {
-  syntaxHighlight: "shiki",
+  syntaxHighlight: syntaxHighlightDefaults,
   shikiConfig: {
     langs: [],
     theme: "github-dark",
@@ -50,7 +55,8 @@ async function createMarkdownProcessor(opts) {
     rehypePlugins = markdownConfigDefaults.rehypePlugins,
     remarkRehype: remarkRehypeOptions = markdownConfigDefaults.remarkRehype,
     gfm = markdownConfigDefaults.gfm,
-    smartypants = markdownConfigDefaults.smartypants
+    smartypants = markdownConfigDefaults.smartypants,
+    experimentalHeadingIdCompat = false
   } = opts ?? {};
   const loadedRemarkPlugins = await Promise.all(loadPlugins(remarkPlugins));
   const loadedRehypePlugins = await Promise.all(loadPlugins(rehypePlugins));
@@ -74,11 +80,13 @@ async function createMarkdownProcessor(opts) {
     passThrough: [],
     ...remarkRehypeOptions
   });
-  if (!isPerformanceBenchmark) {
-    if (syntaxHighlight === "shiki") {
-      parser.use(rehypeShiki, shikiConfig);
-    } else if (syntaxHighlight === "prism") {
-      parser.use(rehypePrism);
+  if (syntaxHighlight && !isPerformanceBenchmark) {
+    const syntaxHighlightType = typeof syntaxHighlight === "string" ? syntaxHighlight : syntaxHighlight?.type;
+    const excludeLangs = typeof syntaxHighlight === "object" ? syntaxHighlight?.excludeLangs : void 0;
+    if (syntaxHighlightType === "shiki") {
+      parser.use(rehypeShiki, shikiConfig, excludeLangs);
+    } else if (syntaxHighlightType === "prism") {
+      parser.use(rehypePrism, excludeLangs);
     }
   }
   for (const [plugin, pluginOpts] of loadedRehypePlugins) {
@@ -86,7 +94,7 @@ async function createMarkdownProcessor(opts) {
   }
   parser.use(rehypeImages);
   if (!isPerformanceBenchmark) {
-    parser.use(rehypeHeadingIds);
+    parser.use(rehypeHeadingIds, { experimentalHeadingIdCompat });
   }
   parser.use(rehypeRaw).use(rehypeStringify, { allowDangerousHtml: true });
   return {
@@ -144,5 +152,6 @@ export {
   rehypeHeadingIds2 as rehypeHeadingIds,
   rehypePrism2 as rehypePrism,
   rehypeShiki2 as rehypeShiki,
-  remarkCollectImages2 as remarkCollectImages
+  remarkCollectImages2 as remarkCollectImages,
+  syntaxHighlightDefaults
 };

package/dist/rehype-collect-headings.d.ts

@@ -1,2 +1,11 @@
 import type { RehypePlugin } from './types.js';
-export declare function rehypeHeadingIds(): ReturnType<RehypePlugin>;
+/**
+ * Rehype plugin that adds `id` attributes to headings based on their text content.
+ *
+ * @param options Optional configuration object for the plugin.
+ *
+ * @see https://docs.astro.build/en/guides/markdown-content/#heading-ids-and-plugins
+ */
+export declare function rehypeHeadingIds({ experimentalHeadingIdCompat, }?: {
+    experimentalHeadingIdCompat?: boolean;
+}): ReturnType<RehypePlugin>;

package/dist/rehype-collect-headings.js

@@ -2,7 +2,9 @@ import Slugger from "github-slugger";
 import { visit } from "unist-util-visit";
 const rawNodeTypes = /* @__PURE__ */ new Set(["text", "raw", "mdxTextExpression"]);
 const codeTagNames = /* @__PURE__ */ new Set(["code", "pre"]);
-function rehypeHeadingIds() {
+function rehypeHeadingIds({
+  experimentalHeadingIdCompat
+} = {}) {
   return function(tree, file) {
     const headings = [];
     const frontmatter = file.data.astro?.frontmatter;
@@ -49,7 +51,9 @@ function rehypeHeadingIds() {
       node.properties = node.properties || {};
       if (typeof node.properties.id !== "string") {
         let slug = slugger.slug(text);
-        if (slug.endsWith("-")) slug = slug.slice(0, -1);
+        if (!experimentalHeadingIdCompat) {
+          if (slug.endsWith("-")) slug = slug.slice(0, -1);
+        }
         node.properties.id = slug;
       }
       headings.push({ depth, slug: node.properties.id, text });

package/dist/rehype-prism.d.ts

@@ -1,3 +1,3 @@
 import type { Root } from 'hast';
 import type { Plugin } from 'unified';
-export declare const rehypePrism: Plugin<[], Root>;
+export declare const rehypePrism: Plugin<[string[]?], Root>;

package/dist/rehype-prism.js

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

package/dist/rehype-shiki.d.ts

@@ -1,4 +1,4 @@
 import type { Root } from 'hast';
 import type { Plugin } from 'unified';
 import type { ShikiConfig } from './types.js';
-export declare const rehypeShiki: Plugin<[ShikiConfig?], Root>;
+export declare const rehypeShiki: Plugin<[ShikiConfig, string[]?], Root>;

package/dist/rehype-shiki.js

@@ -1,6 +1,6 @@
 import { highlightCodeBlocks } from "./highlight.js";
 import { createShikiHighlighter } from "./shiki.js";
-const rehypeShiki = (config) => {
+const rehypeShiki = (config, excludeLangs) => {
   let highlighterAsync;
   return async (tree) => {
     highlighterAsync ??= createShikiHighlighter({
@@ -10,14 +10,18 @@ const rehypeShiki = (config) => {
       langAlias: config?.langAlias
     });
     const highlighter = await highlighterAsync;
-    await highlightCodeBlocks(tree, (code, language, options) => {
-      return highlighter.codeToHast(code, language, {
-        meta: options?.meta,
-        wrap: config?.wrap,
-        defaultColor: config?.defaultColor,
-        transformers: config?.transformers
-      });
-    });
+    await highlightCodeBlocks(
+      tree,
+      (code, language, options) => {
+        return highlighter.codeToHast(code, language, {
+          meta: options?.meta,
+          wrap: config?.wrap,
+          defaultColor: config?.defaultColor,
+          transformers: config?.transformers
+        });
+      },
+      excludeLangs
+    );
   };
 };
 export {

package/dist/types.d.ts

@@ -22,13 +22,18 @@ export type RehypePlugin<PluginParameters extends any[] = any[]> = unified.Plugi
 export type RehypePlugins = (string | [string, any] | RehypePlugin | [RehypePlugin, any])[];
 export type RemarkRehype = RemarkRehypeOptions;
 export type ThemePresets = BuiltinTheme | 'css-variables';
+export type SyntaxHighlightConfigType = 'shiki' | 'prism';
+export interface SyntaxHighlightConfig {
+    type: SyntaxHighlightConfigType;
+    excludeLangs?: string[];
+}
 export interface ShikiConfig extends Pick<CreateShikiHighlighterOptions, 'langs' | 'theme' | 'themes' | 'langAlias'>, Pick<ShikiHighlighterHighlightOptions, 'defaultColor' | 'wrap' | 'transformers'> {
 }
 /**
  * Configuration options that end up in the markdown section of AstroConfig
  */
 export interface AstroMarkdownOptions {
-    syntaxHighlight?: 'shiki' | 'prism' | false;
+    syntaxHighlight?: SyntaxHighlightConfig | SyntaxHighlightConfigType | false;
     shikiConfig?: ShikiConfig;
     remarkPlugins?: RemarkPlugins;
     rehypePlugins?: RehypePlugins;
@@ -44,6 +49,7 @@ export interface AstroMarkdownProcessorOptions extends AstroMarkdownOptions {
         domains?: string[];
         remotePatterns?: RemotePattern[];
     };
+    experimentalHeadingIdCompat?: boolean;
 }
 export interface MarkdownProcessor {
     render: (content: string, opts?: MarkdownProcessorRenderOptions) => Promise<MarkdownProcessorRenderResult>;

package/package.json

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