@astrojs/markdown-remark 1.1.3 → 2.0.0-beta.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/markdown-remark:build: cache hit, replaying output 724460aa5e72591a
+@astrojs/markdown-remark:build: cache hit, replaying output 34663a00ad52a28a
 @astrojs/markdown-remark:build: 
-@astrojs/markdown-remark:build: > @astrojs/markdown-remark@1.1.3 build /home/runner/work/astro/astro/packages/markdown/remark
+@astrojs/markdown-remark:build: > @astrojs/markdown-remark@2.0.0-beta.0 build /home/runner/work/astro/astro/packages/markdown/remark
 @astrojs/markdown-remark:build: > astro-scripts build "src/**/*.ts" && tsc -p tsconfig.json
 @astrojs/markdown-remark:build: 

package/CHANGELOG.md

@@ -1,5 +1,117 @@
 # @astrojs/markdown-remark
 
+## 2.0.0-beta.0
+
+### Major Changes
+
+- [#5687](https://github.com/withastro/astro/pull/5687) [`e2019be6f`](https://github.com/withastro/astro/commit/e2019be6ffa46fa33d92cfd346f9ecbe51bb7144) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Give remark and rehype plugins access to user frontmatter via frontmatter injection. This means `data.astro.frontmatter` is now the _complete_ Markdown or MDX document's frontmatter, rather than an empty object.
+
+  This allows plugin authors to modify existing frontmatter, or compute new properties based on other properties. For example, say you want to compute a full image URL based on an `imageSrc` slug in your document frontmatter:
+
+  ```ts
+  export function remarkInjectSocialImagePlugin() {
+    return function (tree, file) {
+      const { frontmatter } = file.data.astro;
+      frontmatter.socialImageSrc = new URL(frontmatter.imageSrc, 'https://my-blog.com/').pathname;
+    };
+  }
+  ```
+
+  #### Content Collections - new `remarkPluginFrontmatter` property
+
+  We have changed _inject_ frontmatter to _modify_ frontmatter in our docs to improve discoverability. This is based on support forum feedback, where "injection" is rarely the term used.
+
+  To reflect this, the `injectedFrontmatter` property has been renamed to `remarkPluginFrontmatter`. This should clarify this plugin is still separate from the `data` export Content Collections expose today.
+
+  #### Migration instructions
+
+  Plugin authors should now **check for user frontmatter when applying defaults.**
+
+  For example, say a remark plugin wants to apply a default `title` if none is present. Add a conditional to check if the property is present, and update if none exists:
+
+  ```diff
+  export function remarkInjectTitlePlugin() {
+    return function (tree, file) {
+      const { frontmatter } = file.data.astro;
+  +    if (!frontmatter.title) {
+        frontmatter.title = 'Default title';
+  +    }
+    }
+  }
+  ```
+
+  This differs from previous behavior, where a Markdown file's frontmatter would _always_ override frontmatter injected via remark or reype.
+
+- [#5684](https://github.com/withastro/astro/pull/5684) [`a9c292026`](https://github.com/withastro/astro/commit/a9c2920264e36cc5dc05f4adc1912187979edb0d) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Refine Markdown and MDX configuration options for ease-of-use.
+
+  #### Markdown
+
+  - **Remove `remark-smartypants`** from Astro's default Markdown plugins.
+  - **Replace the `extendDefaultPlugins` option** with a simplified `gfm` boolean. This is enabled by default, and can be disabled to remove GitHub-Flavored Markdown.
+  - Ensure GitHub-Flavored Markdown is applied whether or not custom `remarkPlugins` or `rehypePlugins` are configured. If you want to apply custom plugins _and_ remove GFM, manually set `gfm: false` in your config.
+
+  #### MDX
+
+  - Support _all_ Markdown configuration options (except `drafts`) from your MDX integration config. This includes `syntaxHighlighting` and `shikiConfig` options to further customize the MDX renderer.
+  - Simplify `extendDefaults` to an `extendMarkdownConfig` option. MDX options will default to their equivalent in your Markdown config. By setting `extendMarkdownConfig` to false, you can "eject" to set your own syntax highlighting, plugins, and more.
+
+  #### Migration
+
+  To preserve your existing Markdown and MDX setup, you may need some configuration changes:
+
+  ##### Smartypants manual installation
+
+  [Smartypants](https://github.com/silvenon/remark-smartypants) has been removed from Astro's default setup. If you rely on this plugin, [install `remark-smartypants`](https://github.com/silvenon/remark-smartypants#installing) and apply to your `astro.config.*`:
+
+  ```diff
+  // astro.config.mjs
+  import { defineConfig } from 'astro/config';
+  + import smartypants from 'remark-smartypants';
+
+  export default defineConfig({
+    markdown: {
+  +   remarkPlugins: [smartypants],
+    }
+  });
+  ```
+
+  ##### Migrate `extendDefaultPlugins` to `gfm`
+
+  You may have disabled Astro's built-in plugins (GitHub-Flavored Markdown and Smartypants) with the `extendDefaultPlugins` option. Since Smartypants has been removed, this has been renamed to `gfm`.
+
+  ```diff
+  // astro.config.mjs
+  import { defineConfig } from 'astro/config';
+
+  export default defineConfig({
+    markdown: {
+  -   extendDefaultPlugins: false,
+  +   gfm: false,
+    }
+  });
+  ```
+
+  Additionally, applying remark and rehype plugins **no longer disables** `gfm`. You will need to opt-out manually by setting `gfm` to `false`.
+
+  ##### Migrate MDX's `extendPlugins` to `extendMarkdownConfig`
+
+  You may have used the `extendPlugins` option to manage plugin defaults in MDX. This has been replaced by 2 flags:
+
+  - `extendMarkdownConfig` (`true` by default) to toggle Markdown config inheritance. This replaces the `extendPlugins: 'markdown'` option.
+  - `gfm` (`true` by default) to toggle GitHub-Flavored Markdown in MDX. This replaces the `extendPlugins: 'defaults'` option.
+
+## 1.2.0
+
+### Minor Changes
+
+- [#5654](https://github.com/withastro/astro/pull/5654) [`2c65b433b`](https://github.com/withastro/astro/commit/2c65b433bf840a1bb93b0a1947df5949e33512ff) Thanks [@delucis](https://github.com/delucis)! - Refactor and export `rehypeHeadingIds` plugin
+
+  The `rehypeHeadingIds` plugin injects IDs for all headings in a Markdown document and can now also handle MDX inputs if needed. You can import and use this plugin if you need heading IDs to be injected _before_ other rehype plugins run.
+
+### Patch Changes
+
+- [#5648](https://github.com/withastro/astro/pull/5648) [`853081d1c`](https://github.com/withastro/astro/commit/853081d1c857d8ad8a9634c37ed8fd123d32d241) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Prevent relative image paths in `src/content/`
+
 ## 1.1.3
 
 ### Patch Changes
@@ -242,7 +354,7 @@
 
 ### Minor Changes
 
-- [`e425f896`](https://github.com/withastro/astro/commit/e425f896b668d98033ad3b998b50c1f28bc7f6ee) Thanks [@FredKSchott](https://github.com/FredKSchott)! - Update config options to resepect [RFC0019](https://github.com/withastro/rfcs/blob/main/proposals/0019-config-finalization.md)
+- [`e425f896`](https://github.com/withastro/astro/commit/e425f896b668d98033ad3b998b50c1f28bc7f6ee) Thanks [@FredKSchott](https://github.com/FredKSchott)! - Update config options to respect [RFC0019](https://github.com/withastro/rfcs/blob/main/proposals/0019-config-finalization.md)
 
 ## 0.7.0
 

package/dist/frontmatter-injection.d.ts

@@ -0,0 +1,8 @@
+import type { Data, VFile } from 'vfile';
+import type { MarkdownAstroData } from './types.js';
+export declare class InvalidAstroDataError extends TypeError {
+}
+export declare function safelyGetAstroData(vfileData: Data): MarkdownAstroData | InvalidAstroDataError;
+export declare function toRemarkInitializeAstroData({ userFrontmatter, }: {
+    userFrontmatter: Record<string, any>;
+}): () => (tree: any, vfile: VFile) => void;

package/dist/frontmatter-injection.js

@@ -0,0 +1,35 @@
+function isValidAstroData(obj) {
+  if (typeof obj === "object" && obj !== null && obj.hasOwnProperty("frontmatter")) {
+    const { frontmatter } = obj;
+    try {
+      JSON.stringify(frontmatter);
+    } catch {
+      return false;
+    }
+    return typeof frontmatter === "object" && frontmatter !== null;
+  }
+  return false;
+}
+class InvalidAstroDataError extends TypeError {
+}
+function safelyGetAstroData(vfileData) {
+  const { astro } = vfileData;
+  if (!astro || !isValidAstroData(astro)) {
+    return new InvalidAstroDataError();
+  }
+  return astro;
+}
+function toRemarkInitializeAstroData({
+  userFrontmatter
+}) {
+  return () => function(tree, vfile) {
+    if (!vfile.data.astro) {
+      vfile.data.astro = { frontmatter: userFrontmatter };
+    }
+  };
+}
+export {
+  InvalidAstroDataError,
+  safelyGetAstroData,
+  toRemarkInitializeAstroData
+};

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import type { MarkdownRenderingOptions, MarkdownRenderingResult } from './types';
+import type { AstroMarkdownOptions, MarkdownRenderingOptions, MarkdownRenderingResult } from './types';
+export { rehypeHeadingIds } from './rehype-collect-headings.js';
 export * from './types.js';
-export declare const DEFAULT_REMARK_PLUGINS: string[];
-export declare const DEFAULT_REHYPE_PLUGINS: never[];
+export declare const markdownConfigDefaults: Omit<Required<AstroMarkdownOptions>, 'drafts'>;
 /** Shared utility for rendering markdown */
 export declare function renderMarkdown(content: string, opts: MarkdownRenderingOptions): Promise<MarkdownRenderingResult>;

package/dist/index.js

@@ -1,11 +1,12 @@
+import { toRemarkInitializeAstroData } from "./frontmatter-injection.js";
 import { loadPlugins } from "./load-plugins.js";
-import createCollectHeadings from "./rehype-collect-headings.js";
+import { rehypeHeadingIds } from "./rehype-collect-headings.js";
 import rehypeEscape from "./rehype-escape.js";
 import rehypeExpressions from "./rehype-expressions.js";
 import rehypeIslands from "./rehype-islands.js";
 import rehypeJsx from "./rehype-jsx.js";
+import toRemarkContentRelImageError from "./remark-content-rel-image-error.js";
 import remarkEscape from "./remark-escape.js";
-import { remarkInitializeAstroData } from "./remark-initialize-astro-data.js";
 import remarkMarkAndUnravel from "./remark-mark-and-unravel.js";
 import remarkMdxish from "./remark-mdxish.js";
 import remarkPrism from "./remark-prism.js";
@@ -14,32 +15,45 @@ import remarkShiki from "./remark-shiki.js";
 import remarkUnwrap from "./remark-unwrap.js";
 import rehypeRaw from "rehype-raw";
 import rehypeStringify from "rehype-stringify";
+import remarkGfm from "remark-gfm";
 import markdown from "remark-parse";
 import markdownToHtml from "remark-rehype";
 import { unified } from "unified";
 import { VFile } from "vfile";
+import { rehypeHeadingIds as rehypeHeadingIds2 } from "./rehype-collect-headings.js";
 export * from "./types.js";
-const DEFAULT_REMARK_PLUGINS = ["remark-gfm", "remark-smartypants"];
-const DEFAULT_REHYPE_PLUGINS = [];
+const markdownConfigDefaults = {
+  syntaxHighlight: "shiki",
+  shikiConfig: {
+    langs: [],
+    theme: "github-dark",
+    wrap: false
+  },
+  remarkPlugins: [],
+  rehypePlugins: [],
+  remarkRehype: {},
+  gfm: true
+};
 async function renderMarkdown(content, opts) {
   var _a;
   let {
     fileURL,
-    syntaxHighlight = "shiki",
-    shikiConfig = {},
-    remarkPlugins = [],
-    rehypePlugins = [],
-    remarkRehype = {},
-    extendDefaultPlugins = false,
-    isAstroFlavoredMd = false
+    syntaxHighlight = markdownConfigDefaults.syntaxHighlight,
+    shikiConfig = markdownConfigDefaults.shikiConfig,
+    remarkPlugins = markdownConfigDefaults.remarkPlugins,
+    rehypePlugins = markdownConfigDefaults.rehypePlugins,
+    remarkRehype = markdownConfigDefaults.remarkRehype,
+    gfm = markdownConfigDefaults.gfm,
+    isAstroFlavoredMd = false,
+    isExperimentalContentCollections = false,
+    contentDir,
+    frontmatter: userFrontmatter = {}
   } = opts;
   const input = new VFile({ value: content, path: fileURL });
   const scopedClassName = (_a = opts.$) == null ? void 0 : _a.scopedClassName;
-  const { headings, rehypeCollectHeadings } = createCollectHeadings();
-  let parser = unified().use(markdown).use(remarkInitializeAstroData).use(isAstroFlavoredMd ? [remarkMdxish, remarkMarkAndUnravel, remarkUnwrap, remarkEscape] : []);
-  if (extendDefaultPlugins || remarkPlugins.length === 0 && rehypePlugins.length === 0) {
-    remarkPlugins = [...DEFAULT_REMARK_PLUGINS, ...remarkPlugins];
-    rehypePlugins = [...DEFAULT_REHYPE_PLUGINS, ...rehypePlugins];
+  let parser = unified().use(markdown).use(toRemarkInitializeAstroData({ userFrontmatter })).use(isAstroFlavoredMd ? [remarkMdxish, remarkMarkAndUnravel, remarkUnwrap, remarkEscape] : []);
+  if (gfm) {
+    parser.use(remarkGfm);
   }
   const loadedRemarkPlugins = await Promise.all(loadPlugins(remarkPlugins));
   const loadedRehypePlugins = await Promise.all(loadPlugins(rehypePlugins));
@@ -54,6 +68,9 @@ async function renderMarkdown(content, opts) {
   } else if (syntaxHighlight === "prism") {
     parser.use([remarkPrism(scopedClassName)]);
   }
+  if (isExperimentalContentCollections) {
+    parser.use([toRemarkContentRelImageError({ contentDir })]);
+  }
   parser.use([
     [
       markdownToHtml,
@@ -74,7 +91,7 @@ async function renderMarkdown(content, opts) {
     parser.use([[plugin, pluginOpts]]);
   });
   parser.use(
-    isAstroFlavoredMd ? [rehypeJsx, rehypeExpressions, rehypeEscape, rehypeIslands, rehypeCollectHeadings] : [rehypeCollectHeadings, rehypeRaw]
+    isAstroFlavoredMd ? [rehypeJsx, rehypeExpressions, rehypeEscape, rehypeIslands, rehypeHeadingIds] : [rehypeHeadingIds, rehypeRaw]
   ).use(rehypeStringify, { allowDangerousHtml: true });
   let vfile;
   try {
@@ -84,6 +101,7 @@ async function renderMarkdown(content, opts) {
     console.error(err);
     throw err;
   }
+  const headings = (vfile == null ? void 0 : vfile.data.__astroHeadings) || [];
   return {
     metadata: { headings, source: content, html: String(vfile.value) },
     code: String(vfile.value),
@@ -108,7 +126,7 @@ ${err.message}`;
   return wrappedError;
 }
 export {
-  DEFAULT_REHYPE_PLUGINS,
-  DEFAULT_REMARK_PLUGINS,
+  markdownConfigDefaults,
+  rehypeHeadingIds2 as rehypeHeadingIds,
   renderMarkdown
 };

package/dist/internal.d.ts

@@ -0,0 +1 @@
+export { InvalidAstroDataError, safelyGetAstroData, toRemarkInitializeAstroData, } from './frontmatter-injection.js';

package/dist/internal.js

@@ -0,0 +1,10 @@
+import {
+  InvalidAstroDataError,
+  safelyGetAstroData,
+  toRemarkInitializeAstroData
+} from "./frontmatter-injection.js";
+export {
+  InvalidAstroDataError,
+  safelyGetAstroData,
+  toRemarkInitializeAstroData
+};

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

@@ -1,5 +1,2 @@
-import type { MarkdownHeading, RehypePlugin } from './types.js';
-export default function createCollectHeadings(): {
-    headings: MarkdownHeading[];
-    rehypeCollectHeadings: () => ReturnType<RehypePlugin>;
-};
+import type { RehypePlugin } from './types.js';
+export declare function rehypeHeadingIds(): ReturnType<RehypePlugin>;

package/dist/rehype-collect-headings.js

@@ -1,64 +1,66 @@
 import Slugger from "github-slugger";
 import { toHtml } from "hast-util-to-html";
 import { visit } from "unist-util-visit";
-function createCollectHeadings() {
-  const headings = [];
-  const slugger = new Slugger();
-  function rehypeCollectHeadings() {
-    return function(tree) {
-      visit(tree, (node) => {
-        if (node.type !== "element")
+const rawNodeTypes = /* @__PURE__ */ new Set(["text", "raw", "mdxTextExpression"]);
+const codeTagNames = /* @__PURE__ */ new Set(["code", "pre"]);
+function rehypeHeadingIds() {
+  return function(tree, file) {
+    const headings = [];
+    const slugger = new Slugger();
+    const isMDX = isMDXFile(file);
+    visit(tree, (node) => {
+      if (node.type !== "element")
+        return;
+      const { tagName } = node;
+      if (tagName[0] !== "h")
+        return;
+      const [_, level] = tagName.match(/h([0-6])/) ?? [];
+      if (!level)
+        return;
+      const depth = Number.parseInt(level);
+      let text = "";
+      let isJSX = false;
+      visit(node, (child, __, parent) => {
+        if (child.type === "element" || parent == null) {
           return;
-        const { tagName } = node;
-        if (tagName[0] !== "h")
-          return;
-        const [_, level] = tagName.match(/h([0-6])/) ?? [];
-        if (!level)
-          return;
-        const depth = Number.parseInt(level);
-        let text = "";
-        let isJSX = false;
-        visit(node, (child, __, parent) => {
-          if (child.type === "element" || parent == null) {
+        }
+        if (child.type === "raw") {
+          if (child.value.match(/^\n?<.*>\n?$/)) {
             return;
           }
-          if (child.type === "raw") {
-            if (child.value.match(/^\n?<.*>\n?$/)) {
-              return;
-            }
-          }
-          if (child.type === "text" || child.type === "raw") {
-            if ((/* @__PURE__ */ new Set(["code", "pre"])).has(parent.tagName)) {
-              text += child.value;
-            } else {
-              text += child.value.replace(/\{/g, "${");
-              isJSX = isJSX || child.value.includes("{");
-            }
-          }
-        });
-        node.properties = node.properties || {};
-        if (typeof node.properties.id !== "string") {
-          if (isJSX) {
-            const raw = toHtml(node.children, { allowDangerousHtml: true }).replace(/\n(<)/g, "<").replace(/(>)\n/g, ">");
-            node.properties.id = `$$slug(\`${text}\`)`;
-            node.type = "raw";
-            node.value = `<${node.tagName} id={${node.properties.id}}>${raw}</${node.tagName}>`;
+        }
+        if (rawNodeTypes.has(child.type)) {
+          if (isMDX || codeTagNames.has(parent.tagName)) {
+            text += child.value;
           } else {
-            let slug = slugger.slug(text);
-            if (slug.endsWith("-"))
-              slug = slug.slice(0, -1);
-            node.properties.id = slug;
+            text += child.value.replace(/\{/g, "${");
+            isJSX = isJSX || child.value.includes("{");
           }
         }
-        headings.push({ depth, slug: node.properties.id, text });
       });
-    };
-  }
-  return {
-    headings,
-    rehypeCollectHeadings
+      node.properties = node.properties || {};
+      if (typeof node.properties.id !== "string") {
+        if (isJSX) {
+          const raw = toHtml(node.children, { allowDangerousHtml: true }).replace(/\n(<)/g, "<").replace(/(>)\n/g, ">");
+          node.properties.id = `$$slug(\`${text}\`)`;
+          node.type = "raw";
+          node.value = `<${node.tagName} id={${node.properties.id}}>${raw}</${node.tagName}>`;
+        } else {
+          let slug = slugger.slug(text);
+          if (slug.endsWith("-"))
+            slug = slug.slice(0, -1);
+          node.properties.id = slug;
+        }
+      }
+      headings.push({ depth, slug: node.properties.id, text });
+    });
+    file.data.__astroHeadings = headings;
   };
 }
+function isMDXFile(file) {
+  var _a;
+  return Boolean((_a = file.history[0]) == null ? void 0 : _a.endsWith(".mdx"));
+}
 export {
-  createCollectHeadings as default
+  rehypeHeadingIds
 };

package/dist/remark-content-rel-image-error.d.ts

@@ -0,0 +1,8 @@
+import type { VFile } from 'vfile';
+/**
+ * `src/content/` does not support relative image paths.
+ * This plugin throws an error if any are found
+ */
+export default function toRemarkContentRelImageError({ contentDir }: {
+    contentDir: URL;
+}): () => (tree: any, vfile: VFile) => void;

package/dist/remark-content-rel-image-error.js

@@ -0,0 +1,39 @@
+import { visit } from "unist-util-visit";
+import { pathToFileURL } from "url";
+function toRemarkContentRelImageError({ contentDir }) {
+  return function remarkContentRelImageError() {
+    return (tree, vfile) => {
+      const isContentFile = pathToFileURL(vfile.path).href.startsWith(contentDir.href);
+      if (!isContentFile)
+        return;
+      const relImagePaths = /* @__PURE__ */ new Set();
+      visit(tree, "image", function raiseError(node) {
+        if (isRelativePath(node.url)) {
+          relImagePaths.add(node.url);
+        }
+      });
+      if (relImagePaths.size === 0)
+        return;
+      const errorMessage = `Relative image paths are not supported in the content/ directory. Place local images in the public/ directory and use absolute paths (see https://docs.astro.build/en/guides/images/#in-markdown-files)
+` + [...relImagePaths].map((path) => JSON.stringify(path)).join(",\n");
+      throw errorMessage;
+    };
+  };
+}
+function isRelativePath(path) {
+  return startsWithDotDotSlash(path) || startsWithDotSlash(path);
+}
+function startsWithDotDotSlash(path) {
+  const c1 = path[0];
+  const c2 = path[1];
+  const c3 = path[2];
+  return c1 === "." && c2 === "." && c3 === "/";
+}
+function startsWithDotSlash(path) {
+  const c1 = path[0];
+  const c2 = path[1];
+  return c1 === "." && c2 === "/";
+}
+export {
+  toRemarkContentRelImageError as default
+};

package/dist/types.d.ts

@@ -5,14 +5,16 @@ import type { ILanguageRegistration, IThemeRegistration, Theme } from 'shiki';
 import type * as unified from 'unified';
 import type { VFile } from 'vfile';
 export type { Node } from 'unist';
+export declare type MarkdownAstroData = {
+    frontmatter: Record<string, any>;
+};
 export declare type RemarkPlugin<PluginParameters extends any[] = any[]> = unified.Plugin<PluginParameters, mdast.Root>;
 export declare type RemarkPlugins = (string | [string, any] | RemarkPlugin | [RemarkPlugin, any])[];
 export declare type RehypePlugin<PluginParameters extends any[] = any[]> = unified.Plugin<PluginParameters, hast.Root>;
 export declare type RehypePlugins = (string | [string, any] | RehypePlugin | [RehypePlugin, any])[];
 export declare type RemarkRehype = Omit<RemarkRehypeOptions, 'handlers' | 'unknownHandler'> & {
-    handlers: typeof Handlers;
-} & {
-    handler: typeof Handler;
+    handlers?: typeof Handlers;
+    handler?: typeof Handler;
 };
 export interface ShikiConfig {
     langs?: ILanguageRegistration[];
@@ -20,14 +22,13 @@ export interface ShikiConfig {
     wrap?: boolean | null;
 }
 export interface AstroMarkdownOptions {
-    mode?: 'md' | 'mdx';
     drafts?: boolean;
     syntaxHighlight?: 'shiki' | 'prism' | false;
     shikiConfig?: ShikiConfig;
     remarkPlugins?: RemarkPlugins;
     rehypePlugins?: RehypePlugins;
     remarkRehype?: RemarkRehype;
-    extendDefaultPlugins?: boolean;
+    gfm?: boolean;
 }
 export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
     /** @internal */
@@ -37,6 +38,12 @@ export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
         scopedClassName: string | null;
     };
     isAstroFlavoredMd?: boolean;
+    /** Used to prevent relative image imports from `src/content/` */
+    isExperimentalContentCollections?: boolean;
+    /** Used to prevent relative image imports from `src/content/` */
+    contentDir: URL;
+    /** Used for frontmatter injection plugins */
+    frontmatter?: Record<string, any>;
 }
 export interface MarkdownHeading {
     depth: number;
@@ -48,6 +55,11 @@ export interface MarkdownMetadata {
     source: string;
     html: string;
 }
+export interface MarkdownVFile extends VFile {
+    data: {
+        __astroHeadings?: MarkdownHeading[];
+    };
+}
 export interface MarkdownRenderingResult {
     metadata: MarkdownMetadata;
     vfile: VFile;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "1.1.3",
+  "version": "2.0.0-beta.0",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -13,7 +13,8 @@
   "homepage": "https://astro.build",
   "main": "./dist/index.js",
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./dist/internal.js": "./dist/internal.js"
   },
   "dependencies": {
     "@astrojs/micromark-extension-mdx-jsx": "^1.0.3",
@@ -34,7 +35,6 @@
     "remark-gfm": "^3.0.1",
     "remark-parse": "^10.0.1",
     "remark-rehype": "^10.1.0",
-    "remark-smartypants": "^2.0.0",
     "shiki": "^0.11.1",
     "unified": "^10.1.2",
     "unist-util-map": "^3.1.1",
@@ -48,7 +48,7 @@
     "@types/mdast": "^3.0.10",
     "@types/mocha": "^9.1.1",
     "@types/unist": "^2.0.6",
-    "astro-scripts": "0.0.8",
+    "astro-scripts": "0.0.9",
     "chai": "^4.3.6",
     "micromark-util-types": "^1.0.2",
     "mocha": "^9.2.2"

package/src/frontmatter-injection.ts

@@ -0,0 +1,41 @@
+import type { Data, VFile } from 'vfile';
+import type { MarkdownAstroData } from './types.js';
+
+function isValidAstroData(obj: unknown): obj is MarkdownAstroData {
+	if (typeof obj === 'object' && obj !== null && obj.hasOwnProperty('frontmatter')) {
+		const { frontmatter } = obj as any;
+		try {
+			// ensure frontmatter is JSON-serializable
+			JSON.stringify(frontmatter);
+		} catch {
+			return false;
+		}
+		return typeof frontmatter === 'object' && frontmatter !== null;
+	}
+	return false;
+}
+
+export class InvalidAstroDataError extends TypeError {}
+
+export function safelyGetAstroData(vfileData: Data): MarkdownAstroData | InvalidAstroDataError {
+	const { astro } = vfileData;
+
+	if (!astro || !isValidAstroData(astro)) {
+		return new InvalidAstroDataError();
+	}
+
+	return astro;
+}
+
+export function toRemarkInitializeAstroData({
+	userFrontmatter,
+}: {
+	userFrontmatter: Record<string, any>;
+}) {
+	return () =>
+		function (tree: any, vfile: VFile) {
+			if (!vfile.data.astro) {
+				vfile.data.astro = { frontmatter: userFrontmatter };
+			}
+		};
+}

package/src/index.ts

@@ -1,13 +1,19 @@
-import type { MarkdownRenderingOptions, MarkdownRenderingResult } from './types';
-
+import type {
+	AstroMarkdownOptions,
+	MarkdownRenderingOptions,
+	MarkdownRenderingResult,
+	MarkdownVFile,
+} from './types';
+
+import { toRemarkInitializeAstroData } from './frontmatter-injection.js';
 import { loadPlugins } from './load-plugins.js';
-import createCollectHeadings from './rehype-collect-headings.js';
+import { rehypeHeadingIds } from './rehype-collect-headings.js';
 import rehypeEscape from './rehype-escape.js';
 import rehypeExpressions from './rehype-expressions.js';
 import rehypeIslands from './rehype-islands.js';
 import rehypeJsx from './rehype-jsx.js';
+import toRemarkContentRelImageError from './remark-content-rel-image-error.js';
 import remarkEscape from './remark-escape.js';
-import { remarkInitializeAstroData } from './remark-initialize-astro-data.js';
 import remarkMarkAndUnravel from './remark-mark-and-unravel.js';
 import remarkMdxish from './remark-mdxish.js';
 import remarkPrism from './remark-prism.js';
@@ -17,15 +23,27 @@ import remarkUnwrap from './remark-unwrap.js';
 
 import rehypeRaw from 'rehype-raw';
 import rehypeStringify from 'rehype-stringify';
+import remarkGfm from 'remark-gfm';
 import markdown from 'remark-parse';
 import markdownToHtml from 'remark-rehype';
 import { unified } from 'unified';
 import { VFile } from 'vfile';
 
+export { rehypeHeadingIds } from './rehype-collect-headings.js';
 export * from './types.js';
 
-export const DEFAULT_REMARK_PLUGINS = ['remark-gfm', 'remark-smartypants'];
-export const DEFAULT_REHYPE_PLUGINS = [];
+export const markdownConfigDefaults: Omit<Required<AstroMarkdownOptions>, 'drafts'> = {
+	syntaxHighlight: 'shiki',
+	shikiConfig: {
+		langs: [],
+		theme: 'github-dark',
+		wrap: false,
+	},
+	remarkPlugins: [],
+	rehypePlugins: [],
+	remarkRehype: {},
+	gfm: true,
+};
 
 /** Shared utility for rendering markdown */
 export async function renderMarkdown(
@@ -34,26 +52,27 @@ export async function renderMarkdown(
 ): Promise<MarkdownRenderingResult> {
 	let {
 		fileURL,
-		syntaxHighlight = 'shiki',
-		shikiConfig = {},
-		remarkPlugins = [],
-		rehypePlugins = [],
-		remarkRehype = {},
-		extendDefaultPlugins = false,
+		syntaxHighlight = markdownConfigDefaults.syntaxHighlight,
+		shikiConfig = markdownConfigDefaults.shikiConfig,
+		remarkPlugins = markdownConfigDefaults.remarkPlugins,
+		rehypePlugins = markdownConfigDefaults.rehypePlugins,
+		remarkRehype = markdownConfigDefaults.remarkRehype,
+		gfm = markdownConfigDefaults.gfm,
 		isAstroFlavoredMd = false,
+		isExperimentalContentCollections = false,
+		contentDir,
+		frontmatter: userFrontmatter = {},
 	} = opts;
 	const input = new VFile({ value: content, path: fileURL });
 	const scopedClassName = opts.$?.scopedClassName;
-	const { headings, rehypeCollectHeadings } = createCollectHeadings();
 
 	let parser = unified()
 		.use(markdown)
-		.use(remarkInitializeAstroData)
+		.use(toRemarkInitializeAstroData({ userFrontmatter }))
 		.use(isAstroFlavoredMd ? [remarkMdxish, remarkMarkAndUnravel, remarkUnwrap, remarkEscape] : []);
 
-	if (extendDefaultPlugins || (remarkPlugins.length === 0 && rehypePlugins.length === 0)) {
-		remarkPlugins = [...DEFAULT_REMARK_PLUGINS, ...remarkPlugins];
-		rehypePlugins = [...DEFAULT_REHYPE_PLUGINS, ...rehypePlugins];
+	if (gfm) {
+		parser.use(remarkGfm);
 	}
 
 	const loadedRemarkPlugins = await Promise.all(loadPlugins(remarkPlugins));
@@ -73,6 +92,11 @@ export async function renderMarkdown(
 		parser.use([remarkPrism(scopedClassName)]);
 	}
 
+	// Apply later in case user plugins resolve relative image paths
+	if (isExperimentalContentCollections) {
+		parser.use([toRemarkContentRelImageError({ contentDir })]);
+	}
+
 	parser.use([
 		[
 			markdownToHtml as any,
@@ -99,12 +123,12 @@ export async function renderMarkdown(
 	parser
 		.use(
 			isAstroFlavoredMd
-				? [rehypeJsx, rehypeExpressions, rehypeEscape, rehypeIslands, rehypeCollectHeadings]
-				: [rehypeCollectHeadings, rehypeRaw]
+				? [rehypeJsx, rehypeExpressions, rehypeEscape, rehypeIslands, rehypeHeadingIds]
+				: [rehypeHeadingIds, rehypeRaw]
 		)
 		.use(rehypeStringify, { allowDangerousHtml: true });
 
-	let vfile: VFile;
+	let vfile: MarkdownVFile;
 	try {
 		vfile = await parser.process(input);
 	} catch (err) {
@@ -116,6 +140,7 @@ export async function renderMarkdown(
 		throw err;
 	}
 
+	const headings = vfile?.data.__astroHeadings || [];
 	return {
 		metadata: { headings, source: content, html: String(vfile.value) },
 		code: String(vfile.value),

package/src/internal.ts

@@ -0,0 +1,5 @@
+export {
+	InvalidAstroDataError,
+	safelyGetAstroData,
+	toRemarkInitializeAstroData,
+} from './frontmatter-injection.js';

package/src/rehype-collect-headings.ts

@@ -2,72 +2,74 @@ import Slugger from 'github-slugger';
 import { toHtml } from 'hast-util-to-html';
 import { visit } from 'unist-util-visit';
 
-import type { MarkdownHeading, RehypePlugin } from './types.js';
+import type { MarkdownHeading, MarkdownVFile, RehypePlugin } from './types.js';
 
-export default function createCollectHeadings() {
-	const headings: MarkdownHeading[] = [];
-	const slugger = new Slugger();
+const rawNodeTypes = new Set(['text', 'raw', 'mdxTextExpression']);
+const codeTagNames = new Set(['code', 'pre']);
 
-	function rehypeCollectHeadings(): ReturnType<RehypePlugin> {
-		return function (tree) {
-			visit(tree, (node) => {
-				if (node.type !== 'element') return;
-				const { tagName } = node;
-				if (tagName[0] !== 'h') return;
-				const [_, level] = tagName.match(/h([0-6])/) ?? [];
-				if (!level) return;
-				const depth = Number.parseInt(level);
+export function rehypeHeadingIds(): ReturnType<RehypePlugin> {
+	return function (tree, file: MarkdownVFile) {
+		const headings: MarkdownHeading[] = [];
+		const slugger = new Slugger();
+		const isMDX = isMDXFile(file);
+		visit(tree, (node) => {
+			if (node.type !== 'element') return;
+			const { tagName } = node;
+			if (tagName[0] !== 'h') return;
+			const [_, level] = tagName.match(/h([0-6])/) ?? [];
+			if (!level) return;
+			const depth = Number.parseInt(level);
 
-				let text = '';
-				let isJSX = false;
-				visit(node, (child, __, parent) => {
-					if (child.type === 'element' || parent == null) {
+			let text = '';
+			let isJSX = false;
+			visit(node, (child, __, parent) => {
+				if (child.type === 'element' || parent == null) {
+					return;
+				}
+				if (child.type === 'raw') {
+					if (child.value.match(/^\n?<.*>\n?$/)) {
 						return;
 					}
-					if (child.type === 'raw') {
-						if (child.value.match(/^\n?<.*>\n?$/)) {
-							return;
-						}
-					}
-					if (child.type === 'text' || child.type === 'raw') {
-						if (new Set(['code', 'pre']).has(parent.tagName)) {
-							text += child.value;
-						} else {
-							text += child.value.replace(/\{/g, '${');
-							isJSX = isJSX || child.value.includes('{');
-						}
+				}
+				if (rawNodeTypes.has(child.type)) {
+					if (isMDX || codeTagNames.has(parent.tagName)) {
+						text += child.value;
+					} else {
+						text += child.value.replace(/\{/g, '${');
+						isJSX = isJSX || child.value.includes('{');
 					}
-				});
+				}
+			});
 
-				node.properties = node.properties || {};
-				if (typeof node.properties.id !== 'string') {
-					if (isJSX) {
-						// HACK: serialized JSX from internal plugins, ignore these for slug
-						const raw = toHtml(node.children, { allowDangerousHtml: true })
-							.replace(/\n(<)/g, '<')
-							.replace(/(>)\n/g, '>');
-						// HACK: for ids that have JSX content, use $$slug helper to generate slug at runtime
-						node.properties.id = `$$slug(\`${text}\`)`;
-						(node as any).type = 'raw';
-						(
-							node as any
-						).value = `<${node.tagName} id={${node.properties.id}}>${raw}</${node.tagName}>`;
-					} else {
-						let slug = slugger.slug(text);
+			node.properties = node.properties || {};
+			if (typeof node.properties.id !== 'string') {
+				if (isJSX) {
+					// HACK: serialized JSX from internal plugins, ignore these for slug
+					const raw = toHtml(node.children, { allowDangerousHtml: true })
+						.replace(/\n(<)/g, '<')
+						.replace(/(>)\n/g, '>');
+					// HACK: for ids that have JSX content, use $$slug helper to generate slug at runtime
+					node.properties.id = `$$slug(\`${text}\`)`;
+					(node as any).type = 'raw';
+					(
+						node as any
+					).value = `<${node.tagName} id={${node.properties.id}}>${raw}</${node.tagName}>`;
+				} else {
+					let slug = slugger.slug(text);
 
-						if (slug.endsWith('-')) slug = slug.slice(0, -1);
+					if (slug.endsWith('-')) slug = slug.slice(0, -1);
 
-						node.properties.id = slug;
-					}
+					node.properties.id = slug;
 				}
+			}
 
-				headings.push({ depth, slug: node.properties.id, text });
-			});
-		};
-	}
+			headings.push({ depth, slug: node.properties.id, text });
+		});
 
-	return {
-		headings,
-		rehypeCollectHeadings,
+		file.data.__astroHeadings = headings;
 	};
 }
+
+function isMDXFile(file: MarkdownVFile) {
+	return Boolean(file.history[0]?.endsWith('.mdx'));
+}

package/src/remark-content-rel-image-error.ts

@@ -0,0 +1,51 @@
+import type { Image } from 'mdast';
+import { visit } from 'unist-util-visit';
+import { pathToFileURL } from 'url';
+import type { VFile } from 'vfile';
+
+/**
+ * `src/content/` does not support relative image paths.
+ * This plugin throws an error if any are found
+ */
+export default function toRemarkContentRelImageError({ contentDir }: { contentDir: URL }) {
+	return function remarkContentRelImageError() {
+		return (tree: any, vfile: VFile) => {
+			const isContentFile = pathToFileURL(vfile.path).href.startsWith(contentDir.href);
+			if (!isContentFile) return;
+
+			const relImagePaths = new Set<string>();
+			visit(tree, 'image', function raiseError(node: Image) {
+				if (isRelativePath(node.url)) {
+					relImagePaths.add(node.url);
+				}
+			});
+			if (relImagePaths.size === 0) return;
+
+			const errorMessage =
+				`Relative image paths are not supported in the content/ directory. Place local images in the public/ directory and use absolute paths (see https://docs.astro.build/en/guides/images/#in-markdown-files)\n` +
+				[...relImagePaths].map((path) => JSON.stringify(path)).join(',\n');
+
+			// Throw raw string to use `astro:markdown` default formatting
+			throw errorMessage;
+		};
+	};
+}
+
+// Following utils taken from `packages/astro/src/core/path.ts`:
+
+function isRelativePath(path: string) {
+	return startsWithDotDotSlash(path) || startsWithDotSlash(path);
+}
+
+function startsWithDotDotSlash(path: string) {
+	const c1 = path[0];
+	const c2 = path[1];
+	const c3 = path[2];
+	return c1 === '.' && c2 === '.' && c3 === '/';
+}
+
+function startsWithDotSlash(path: string) {
+	const c1 = path[0];
+	const c2 = path[1];
+	return c1 === '.' && c2 === '/';
+}

package/src/types.ts

@@ -11,6 +11,10 @@ import type { VFile } from 'vfile';
 
 export type { Node } from 'unist';
 
+export type MarkdownAstroData = {
+	frontmatter: Record<string, any>;
+};
+
 export type RemarkPlugin<PluginParameters extends any[] = any[]> = unified.Plugin<
 	PluginParameters,
 	mdast.Root
@@ -26,8 +30,9 @@ export type RehypePlugin<PluginParameters extends any[] = any[]> = unified.Plugi
 export type RehypePlugins = (string | [string, any] | RehypePlugin | [RehypePlugin, any])[];
 
 export type RemarkRehype = Omit<RemarkRehypeOptions, 'handlers' | 'unknownHandler'> & {
-	handlers: typeof Handlers;
-} & { handler: typeof Handler };
+	handlers?: typeof Handlers;
+	handler?: typeof Handler;
+};
 
 export interface ShikiConfig {
 	langs?: ILanguageRegistration[];
@@ -36,14 +41,13 @@ export interface ShikiConfig {
 }
 
 export interface AstroMarkdownOptions {
-	mode?: 'md' | 'mdx';
 	drafts?: boolean;
 	syntaxHighlight?: 'shiki' | 'prism' | false;
 	shikiConfig?: ShikiConfig;
 	remarkPlugins?: RemarkPlugins;
 	rehypePlugins?: RehypePlugins;
 	remarkRehype?: RemarkRehype;
-	extendDefaultPlugins?: boolean;
+	gfm?: boolean;
 }
 
 export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
@@ -54,6 +58,12 @@ export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
 		scopedClassName: string | null;
 	};
 	isAstroFlavoredMd?: boolean;
+	/** Used to prevent relative image imports from `src/content/` */
+	isExperimentalContentCollections?: boolean;
+	/** Used to prevent relative image imports from `src/content/` */
+	contentDir: URL;
+	/** Used for frontmatter injection plugins */
+	frontmatter?: Record<string, any>;
 }
 
 export interface MarkdownHeading {
@@ -68,6 +78,12 @@ export interface MarkdownMetadata {
 	html: string;
 }
 
+export interface MarkdownVFile extends VFile {
+	data: {
+		__astroHeadings?: MarkdownHeading[];
+	};
+}
+
 export interface MarkdownRenderingResult {
 	metadata: MarkdownMetadata;
 	vfile: VFile;

package/dist/remark-initialize-astro-data.d.ts

@@ -1,2 +0,0 @@
-import type { VFile } from 'vfile';
-export declare function remarkInitializeAstroData(): (tree: any, vfile: VFile) => void;

package/dist/remark-initialize-astro-data.js

@@ -1,10 +0,0 @@
-function remarkInitializeAstroData() {
-  return function(tree, vfile) {
-    if (!vfile.data.astro) {
-      vfile.data.astro = { frontmatter: {} };
-    }
-  };
-}
-export {
-  remarkInitializeAstroData
-};

package/src/remark-initialize-astro-data.ts

@@ -1,9 +0,0 @@
-import type { VFile } from 'vfile';
-
-export function remarkInitializeAstroData() {
-	return function (tree: any, vfile: VFile) {
-		if (!vfile.data.astro) {
-			vfile.data.astro = { frontmatter: {} };
-		}
-	};
-}