feat: improve AcceptMarkdown support #209
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import assert from "node:assert/strict"; | ||
| import { describe, test } from "node:test"; | ||
| import { unified } from "unified"; | ||
| import remarkMdx from "remark-mdx"; | ||
| import remarkParse from "remark-parse"; | ||
| import remarkMarkdownImageMap from "./remark-markdown-image-map"; | ||
|
|
||
| async function collectMarkdownImageMap(markdown: string) { | ||
| const processor = unified().use(remarkParse).use(remarkMdx).use(remarkMarkdownImageMap); | ||
| const file = { data: {} }; | ||
| const tree = processor.parse(markdown); | ||
|
|
||
| await processor.run(tree, file as any); | ||
| return file.data as { | ||
| markdownImageMap?: Record<string, string>; | ||
| "mdx-export"?: Array<{ name: string; value: unknown }>; | ||
| }; | ||
| } | ||
|
|
||
| describe("remarkMarkdownImageMap", () => { | ||
| test("exports normalized image URLs keyed by Fumadocs placeholders", async () => { | ||
| const data = await collectMarkdownImageMap(` | ||
|  | ||
|
|
||
|  | ||
| `); | ||
|
|
||
| assert.deepEqual(data.markdownImageMap, { | ||
| __img0: "/docs/images/first.png", | ||
| __img1: "/docs/images/second.png?size=large#preview", | ||
| }); | ||
| assert.deepEqual(data["mdx-export"], [ | ||
| { | ||
| name: "markdownImageMap", | ||
| value: data.markdownImageMap, | ||
| }, | ||
| ]); | ||
| }); | ||
|
|
||
| test("includes JSX image sources without shifting markdown image placeholders", async () => { | ||
| const data = await collectMarkdownImageMap(` | ||
|  | ||
|
|
||
| <Frame> | ||
| <img src="/images/frame.png" alt="Frame screenshot" /> | ||
| </Frame> | ||
|
|
||
|  | ||
| `); | ||
|
|
||
| assert.deepEqual(data.markdownImageMap, { | ||
| __img0: "/docs/images/first.png", | ||
| __img1: "/docs/images/third.png", | ||
| __img2: "/docs/images/frame.png", | ||
| }); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| import { visit } from "unist-util-visit"; | ||
| import { normalizeDocsAssetPath } from "../src/lib/docs-asset-path"; | ||
|
|
||
| const imagePlaceholderPattern = /^__img\d+$/; | ||
|
|
||
| function getAttributeValue(node: any, name: string): string | undefined { | ||
| for (const attribute of node.attributes ?? []) { | ||
| if (attribute.name !== name) continue; | ||
|
|
||
| const value = attribute.value; | ||
| if (typeof value === "string") return value; | ||
| if (typeof value?.value === "string") return value.value; | ||
| } | ||
| } | ||
|
|
||
| function getImageUrl(node: any): string | undefined { | ||
| if (typeof node.url === "string") return normalizeDocsAssetPath(node.url); | ||
|
|
||
| const src = getAttributeValue(node, "src"); | ||
| if (!src || imagePlaceholderPattern.test(src)) return undefined; | ||
|
|
||
| return normalizeDocsAssetPath(src); | ||
| } | ||
|
|
||
| export default function remarkMarkdownImageMap() { | ||
| return (tree: any, file: any) => { | ||
| const imageMap: Record<string, string> = {}; | ||
| let imageIndex = 0; | ||
| const jsxImageUrls: string[] = []; | ||
|
|
||
| visit(tree, "image", (node: any) => { | ||
| const url = getImageUrl(node); | ||
| if (!url) return; | ||
|
|
||
| imageMap[`__img${imageIndex}`] = url; | ||
| imageIndex += 1; | ||
| }); | ||
|
|
||
| visit(tree, ["mdxJsxFlowElement", "mdxJsxTextElement"], (node: any) => { | ||
| if (node.name !== "img") return; | ||
|
|
||
| const url = getImageUrl(node); | ||
| if (!url) return; | ||
|
|
||
| jsxImageUrls.push(url); | ||
| }); | ||
|
|
||
| for (const url of jsxImageUrls) { | ||
| imageMap[`__img${imageIndex}`] = url; | ||
| imageIndex += 1; | ||
| } | ||
|
|
||
| if (Object.keys(imageMap).length > 0) { | ||
| file.data.markdownImageMap = imageMap; | ||
| file.data["mdx-export"] ??= []; | ||
| file.data["mdx-export"].push({ | ||
| name: "markdownImageMap", | ||
| value: imageMap, | ||
| }); | ||
| } | ||
| }; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| const DOCS_PREFIX = "/docs"; | ||
| const SPECIAL_URL_PATTERN = /^[a-zA-Z][a-zA-Z\d+\-.]*:/; | ||
|
|
||
| export function normalizeDocsAssetPath(url: string): string { | ||
| const trimmed = url.trim(); | ||
| if (!trimmed) return trimmed; | ||
|
|
||
| if (trimmed.startsWith("#") || trimmed.startsWith("//") || SPECIAL_URL_PATTERN.test(trimmed)) { | ||
| return trimmed; | ||
| } | ||
|
|
||
| const [, pathPart = "", suffix = ""] = trimmed.match(/^([^?#]*)([?#].*)?$/) ?? []; | ||
| const segments = pathPart.replace(/^\/+/, "").split("/").filter(Boolean); | ||
|
|
||
| const normalizedSegments: string[] = []; | ||
| for (const segment of segments) { | ||
| if (segment === "." || segment === "") continue; | ||
| if (segment === "..") { | ||
| normalizedSegments.pop(); | ||
| continue; | ||
| } | ||
| normalizedSegments.push(segment); | ||
| } | ||
|
|
||
| const normalizedPath = `/${normalizedSegments.join("/")}`; | ||
| if (normalizedPath === DOCS_PREFIX || normalizedPath.startsWith(`${DOCS_PREFIX}/`)) { | ||
| return `${normalizedPath}${suffix}`; | ||
| } | ||
|
|
||
| return `${DOCS_PREFIX}${normalizedPath === "/" ? "" : normalizedPath}${suffix}`; | ||
| } | ||
|
|
||
| export function resolveDocsAssetUrl(url: string, baseUrl?: string) { | ||
| const normalized = normalizeDocsAssetPath(url); | ||
| if (!baseUrl || normalized.startsWith("#") || SPECIAL_URL_PATTERN.test(normalized)) { | ||
| return normalized; | ||
| } | ||
|
|
||
| return new URL(normalized, baseUrl).toString(); | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.