@astrojs/markdown-remark 1.1.3 → 1.2.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 968e841d80fa22fa
 @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@1.2.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,17 @@
 # @astrojs/markdown-remark
 
+## 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 +254,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/index.d.ts

@@ -1,4 +1,5 @@
 import type { 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[];

package/dist/index.js

@@ -1,9 +1,10 @@
 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";
@@ -18,6 +19,7 @@ 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 = [];
@@ -31,11 +33,12 @@ async function renderMarkdown(content, opts) {
     rehypePlugins = [],
     remarkRehype = {},
     extendDefaultPlugins = false,
-    isAstroFlavoredMd = false
+    isAstroFlavoredMd = false,
+    isExperimentalContentCollections = false,
+    contentDir
   } = 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];
@@ -54,6 +57,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 +80,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 +90,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),
@@ -110,5 +117,6 @@ ${err.message}`;
 export {
   DEFAULT_REHYPE_PLUGINS,
   DEFAULT_REMARK_PLUGINS,
+  rehypeHeadingIds2 as rehypeHeadingIds,
   renderMarkdown
 };

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

@@ -37,6 +37,10 @@ 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;
 }
 export interface MarkdownHeading {
     depth: number;
@@ -48,6 +52,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": "1.2.0",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -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/index.ts

@@ -1,11 +1,12 @@
-import type { MarkdownRenderingOptions, MarkdownRenderingResult } from './types';
+import type { MarkdownRenderingOptions, MarkdownRenderingResult, MarkdownVFile } from './types';
 
 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';
@@ -22,6 +23,7 @@ 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'];
@@ -41,10 +43,11 @@ export async function renderMarkdown(
 		remarkRehype = {},
 		extendDefaultPlugins = false,
 		isAstroFlavoredMd = false,
+		isExperimentalContentCollections = false,
+		contentDir,
 	} = opts;
 	const input = new VFile({ value: content, path: fileURL });
 	const scopedClassName = opts.$?.scopedClassName;
-	const { headings, rehypeCollectHeadings } = createCollectHeadings();
 
 	let parser = unified()
 		.use(markdown)
@@ -73,6 +76,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 +107,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 +124,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/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

@@ -54,6 +54,10 @@ 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;
 }
 
 export interface MarkdownHeading {
@@ -68,6 +72,12 @@ export interface MarkdownMetadata {
 	html: string;
 }
 
+export interface MarkdownVFile extends VFile {
+	data: {
+		__astroHeadings?: MarkdownHeading[];
+	};
+}
+
 export interface MarkdownRenderingResult {
 	metadata: MarkdownMetadata;
 	vfile: VFile;