fumadocs-epub 1.2.2 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.js +14 -6
  2. package/dist/index.js.map +1 -1
  3. package/package.json +6 -7
package/dist/index.js CHANGED
@@ -5,7 +5,6 @@ import { flattenTree } from "fumadocs-core/page-tree";
5
5
  import remarkGfm from "remark-gfm";
6
6
  import remarkRehype from "remark-rehype";
7
7
  import rehypeStringify from "rehype-stringify";
8
- import { visit } from "unist-util-visit";
9
8
  import { remark } from "remark";
10
9
  import fs from "node:fs";
11
10
  //#region src/toc-builder.ts
@@ -49,11 +48,20 @@ function remarkResolveImg() {
49
48
  return (tree, file) => {
50
49
  const { pageDir, publicDir } = file.data;
51
50
  if (!pageDir || !publicDir) return;
52
- visit(tree, "image", (node, idx, parent) => {
53
- const resolved = resolveImageSrc(node.url, pageDir, publicDir);
54
- if (resolved) node.url = resolved;
55
- else if (idx !== void 0 && parent) parent.children.splice(idx, 1);
56
- });
51
+ const visit = (parent) => {
52
+ if (!("children" in parent)) return;
53
+ for (let i = 0; i < parent.children.length; i++) {
54
+ const node = parent.children[i];
55
+ if (node.type !== "image") {
56
+ visit(node);
57
+ continue;
58
+ }
59
+ const resolved = resolveImageSrc(node.url, pageDir, publicDir);
60
+ if (resolved) node.url = resolved;
61
+ else parent.children.splice(i--, 1);
62
+ }
63
+ };
64
+ visit(tree);
57
65
  };
58
66
  }
59
67
  /**
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../src/toc-builder.ts","../src/image-resolver.ts","../src/markdown-to-html.ts","../src/default-styles.ts","../src/index.ts"],"sourcesContent":["import type * as PageTree from 'fumadocs-core/page-tree';\nimport { flattenTree } from 'fumadocs-core/page-tree';\n\n/**\n * Get pages in the order they appear in the page tree (navigation order).\n * Uses flattenTree to traverse the tree depth-first, resolving each Item to a page.\n */\nexport function getPagesInTreeOrder<Page>(\n pageTree: PageTree.Root,\n getNodePage: (node: PageTree.Item) => Page | undefined,\n): Page[] {\n const mainItems = flattenTree(pageTree.children);\n const fallbackItems = pageTree.fallback ? flattenTree(pageTree.fallback.children) : [];\n const items = [...mainItems, ...fallbackItems];\n const pages: Page[] = [];\n\n for (const item of items) {\n const page = getNodePage(item);\n if (page) {\n pages.push(page);\n }\n }\n\n return pages;\n}\n","import path from 'node:path';\nimport { pathToFileURL } from 'node:url';\nimport fs from 'node:fs';\n\n/**\n * Resolve image src to file:// URL for epub-gen-memory to embed.\n * Handles relative paths (resolved from page dir), absolute paths, and remote URLs.\n */\nexport function resolveImageSrc(\n src: string,\n pageDir: string,\n publicDir: string,\n): string | undefined {\n // Already a file:// URL\n if (src.startsWith('file://')) {\n return src;\n }\n\n // Remote URL - epub-gen-memory can fetch these\n if (src.startsWith('http://') || src.startsWith('https://')) {\n return src;\n }\n\n // Data URL - pass through\n if (src.startsWith('data:')) {\n return src;\n }\n\n // Protocol-relative URL (//cdn.example.com/...) - normalize to https:\n if (src.startsWith('//')) {\n return `https:${src}`;\n }\n\n // Absolute path starting with / - could be from public dir\n if (src.startsWith('/')) {\n const resolved = path.join(publicDir, src.slice(1));\n if (fs.existsSync(resolved)) return pathToFileURL(resolved).href;\n }\n // Relative path or others - resolve from page directory\n const resolved = path.resolve(pageDir, src);\n if (fs.existsSync(resolved)) return pathToFileURL(resolved).href;\n}\n","import type { Transformer } from 'unified';\nimport remarkGfm from 'remark-gfm';\nimport remarkRehype from 'remark-rehype';\nimport rehypeStringify from 'rehype-stringify';\nimport type { Root } from 'mdast';\nimport { visit } from 'unist-util-visit';\nimport { remark } from 'remark';\nimport { resolveImageSrc } from './image-resolver';\n\nconst processor = remark()\n .use(remarkGfm)\n .use(remarkResolveImg)\n .use(remarkRehype, { allowDangerousHtml: true })\n .use(rehypeStringify, { allowDangerousHtml: true });\n\ndeclare module 'vfile' {\n export interface DataMap {\n pageDir: string;\n publicDir: string;\n }\n}\n\nfunction remarkResolveImg(): Transformer<Root, Root> {\n return (tree, file) => {\n const { pageDir, publicDir } = file.data;\n if (!pageDir || !publicDir) return;\n\n visit(tree, 'image', (node, idx, parent) => {\n const resolved = resolveImageSrc(node.url, pageDir, publicDir);\n if (resolved) {\n node.url = resolved;\n } else if (idx !== undefined && parent) {\n parent.children.splice(idx, 1);\n }\n });\n };\n}\n\n/**\n * Convert markdown string to HTML suitable for EPUB chapters.\n * Uses unified pipeline: remark-parse -> remark-gfm -> remark-rehype -> rehype-stringify\n */\nexport async function markdownToHtml(\n markdown: string,\n pageDir: string,\n publicDir: string,\n): Promise<string> {\n const result = await processor.process({\n value: markdown,\n data: {\n pageDir,\n publicDir,\n },\n });\n return String(result);\n}\n","/**\n * Minimal, readable CSS stylesheet suitable for e-readers.\n */\nexport const defaultEpubStyles = `\nbody {\n font-family: Georgia, serif;\n font-size: 1em;\n line-height: 1.6;\n margin: 1em;\n}\n\nh1, h2, h3, h4, h5, h6 {\n font-family: Georgia, serif;\n margin-top: 1.5em;\n margin-bottom: 0.5em;\n page-break-after: avoid;\n}\n\nh1 { font-size: 1.5em; }\nh2 { font-size: 1.3em; }\nh3 { font-size: 1.15em; }\n\npre, code {\n font-family: \"Consolas\", \"Monaco\", \"Courier New\", monospace;\n font-size: 0.9em;\n}\n\npre {\n background: #f5f5f5;\n padding: 1em;\n overflow-x: auto;\n page-break-inside: avoid;\n}\n\ncode {\n background: #f5f5f5;\n padding: 0.2em 0.4em;\n}\n\npre code {\n background: none;\n padding: 0;\n}\n\nimg {\n max-width: 100%;\n height: auto;\n}\n\nblockquote {\n margin: 1em 0;\n padding-left: 1em;\n border-left: 4px solid #ccc;\n color: #555;\n}\n\ntable {\n border-collapse: collapse;\n width: 100%;\n page-break-inside: avoid;\n}\n\nth, td {\n border: 1px solid #ddd;\n padding: 0.5em;\n}\n\nth {\n background: #f5f5f5;\n}\n\np {\n margin: 0.75em 0;\n}\n\nul, ol {\n margin: 0.75em 0;\n padding-left: 1.5em;\n}\n\na {\n color: #0066cc;\n}\n`;\n","import epub, { type Options } from 'epub-gen-memory';\nimport path from 'node:path';\nimport { pathToFileURL } from 'node:url';\nimport type { LoaderConfig, Page } from 'fumadocs-core/source';\nimport { getPagesInTreeOrder } from './toc-builder';\nimport { markdownToHtml } from './markdown-to-html';\nimport { defaultEpubStyles } from './default-styles';\nimport type { EpubExportOptions } from './types';\n\nexport { defaultEpubStyles } from './default-styles';\nexport type { EpubConfig, EpubExportOptions } from './types';\n\nexport interface EpubExportAPI {\n GET: (request: Request) => Promise<Response>;\n}\n\n/**\n * A route handler that exports the docs as an EPUB file.\n *\n * The route is guarded by `secret`: it is rejected entirely when the secret is unset (e.g. a missing\n * environment variable), otherwise the request must carry `Authorization: Bearer <secret>`.\n *\n * @example\n * ```ts\n * import { createEpubExportAPI } from 'fumadocs-epub';\n * import { source } from '@/lib/source';\n *\n * export const { GET } = createEpubExportAPI({\n * source,\n * title: 'Documentation',\n * secret: process.env.EXPORT_SECRET,\n * });\n * ```\n */\nexport function createEpubExportAPI<C extends LoaderConfig>(\n options: EpubExportOptions<C> & {\n secret: string | undefined;\n /** @defaultValue 'docs.epub' */\n filename?: string;\n },\n): EpubExportAPI {\n const { secret, filename = 'docs.epub', ...rest } = options;\n\n return {\n async GET(request) {\n if (!secret) return new Response('the export secret is not configured.', { status: 503 });\n const auth = request.headers.get('authorization');\n if (auth?.replace(/^Bearer\\s+/i, '') !== secret)\n return new Response('Unauthorized', { status: auth ? 403 : 401 });\n\n const buffer = await exportEpub(rest as EpubExportOptions<C>);\n\n return new Response(new Uint8Array(buffer), {\n headers: {\n 'Content-Type': 'application/epub+zip',\n 'Content-Disposition': `attachment; filename=\"${filename}\"`,\n },\n });\n },\n };\n}\n\n/**\n * Get page directory for resolving relative image paths\n */\nfunction getPageDir(page: Page, cwd: string): string {\n if (page.absolutePath) {\n return path.dirname(page.absolutePath);\n }\n return path.resolve(cwd, path.dirname(page.path));\n}\n\n/**\n * Resolve cover image path - support file://, http(s)://, /public/..., or relative\n */\nfunction resolveCoverPath(\n cover: string | undefined,\n cwd: string,\n publicDir?: string,\n): string | undefined {\n if (!cover) return undefined;\n if (cover.startsWith('file://') || cover.startsWith('http://') || cover.startsWith('https://'))\n return cover;\n if (cover.startsWith('/')) {\n const base = publicDir ?? path.join(cwd, 'public');\n return pathToFileUrl(path.join(base, cover.slice(1)));\n }\n return pathToFileUrl(path.resolve(cwd, cover));\n}\n\nfunction pathToFileUrl(filePath: string): string {\n return pathToFileURL(filePath).href;\n}\n\n/**\n * Export Fumadocs documentation to EPUB format.\n *\n * @param options - Export configuration with source and epub config\n * @returns Promise resolving to the EPUB file as a Buffer\n *\n * @example\n * ```ts\n * import { exportEpub } from 'fumadocs-epub';\n * import { source } from '@/lib/source';\n *\n * const buffer = await exportEpub({\n * source,\n * title: 'My Documentation',\n * author: 'My Team',\n * cover: '/cover.png',\n * });\n * ```\n */\nexport async function exportEpub<C extends LoaderConfig>(\n options: EpubExportOptions<C>,\n): Promise<Buffer> {\n const cwd = process.cwd();\n const {\n source: input,\n getMarkdown = async (page) => {\n try {\n return await (page.data as { getText: (type: string) => Promise<string> }).getText('raw');\n } catch {\n console.warn(\n `Failed to get processed markdown for page \"${page.absolutePath ?? page.path}\", please specify the \"getMarkdown\" option.`,\n );\n }\n },\n title,\n author = 'anonymous',\n description,\n language = 'en',\n publisher = 'anonymous',\n cover,\n outputPath,\n includePages,\n excludePages,\n css,\n publicDir = path.resolve('public'),\n } = options;\n\n const source = typeof input === 'function' ? await input() : input;\n // Get pages in tree order (navigation order)\n const pageTree = source.getPageTree();\n const orderedPages = getPagesInTreeOrder(pageTree, (node) => source.getNodePage?.(node)).filter(\n (p): p is Page => p != null,\n );\n\n // Fallback to getPages() if tree order yields no pages (e.g. i18n)\n const pages = orderedPages.length > 0 ? orderedPages : source.getPages();\n\n // Filter pages\n const filteredPages = pages.filter((page) => {\n if (includePages && !includePages(page)) return false;\n if (excludePages && excludePages(page)) return false;\n return true;\n });\n\n const chapters: { title: string; content: string }[] = [];\n\n for (const page of filteredPages) {\n const markdown = await getMarkdown(page);\n if (!markdown) continue;\n\n const pageDir = getPageDir(page, cwd);\n const html = await markdownToHtml(markdown, pageDir, publicDir);\n const pageTitle = page.data.title ?? page.slugs[page.slugs.length - 1] ?? 'Untitled';\n\n chapters.push({\n title: pageTitle,\n content: html,\n });\n }\n\n const epubOptions: Options = {\n title,\n author: Array.isArray(author) ? author : [author],\n description,\n lang: language,\n publisher,\n cover: resolveCoverPath(cover, cwd, publicDir) ?? cover,\n css: css ?? defaultEpubStyles,\n prependChapterTitles: true,\n numberChaptersInTOC: true,\n tocTitle: 'Table of Contents',\n };\n\n const content = chapters.map((ch) => ({\n title: ch.title,\n content: ch.content,\n }));\n\n const buffer = await epub(epubOptions, content);\n\n if (outputPath) {\n const fs = await import('node:fs/promises');\n await fs.mkdir(path.dirname(outputPath), { recursive: true });\n await fs.writeFile(outputPath, buffer);\n }\n return buffer;\n}\n"],"mappings":";;;;;;;;;;;;;;;AAOA,SAAgB,oBACd,UACA,aACQ;CACR,MAAM,YAAY,YAAY,SAAS,QAAQ;CAC/C,MAAM,gBAAgB,SAAS,WAAW,YAAY,SAAS,SAAS,QAAQ,IAAI,CAAC;CACrF,MAAM,QAAQ,CAAC,GAAG,WAAW,GAAG,aAAa;CAC7C,MAAM,QAAgB,CAAC;CAEvB,KAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,OAAO,YAAY,IAAI;EAC7B,IAAI,MACF,MAAM,KAAK,IAAI;CAEnB;CAEA,OAAO;AACT;;;;;;;AChBA,SAAgB,gBACd,KACA,SACA,WACoB;CAEpB,IAAI,IAAI,WAAW,SAAS,GAC1B,OAAO;CAIT,IAAI,IAAI,WAAW,SAAS,KAAK,IAAI,WAAW,UAAU,GACxD,OAAO;CAIT,IAAI,IAAI,WAAW,OAAO,GACxB,OAAO;CAIT,IAAI,IAAI,WAAW,IAAI,GACrB,OAAO,SAAS;CAIlB,IAAI,IAAI,WAAW,GAAG,GAAG;EACvB,MAAM,WAAW,KAAK,KAAK,WAAW,IAAI,MAAM,CAAC,CAAC;EAClD,IAAI,GAAG,WAAW,QAAQ,GAAG,OAAO,cAAc,QAAQ,CAAC,CAAC;CAC9D;CAEA,MAAM,WAAW,KAAK,QAAQ,SAAS,GAAG;CAC1C,IAAI,GAAG,WAAW,QAAQ,GAAG,OAAO,cAAc,QAAQ,CAAC,CAAC;AAC9D;;;AChCA,MAAM,YAAY,OAAO,CAAC,CACvB,IAAI,SAAS,CAAC,CACd,IAAI,gBAAgB,CAAC,CACrB,IAAI,cAAc,EAAE,oBAAoB,KAAK,CAAC,CAAC,CAC/C,IAAI,iBAAiB,EAAE,oBAAoB,KAAK,CAAC;AASpD,SAAS,mBAA4C;CACnD,QAAQ,MAAM,SAAS;EACrB,MAAM,EAAE,SAAS,cAAc,KAAK;EACpC,IAAI,CAAC,WAAW,CAAC,WAAW;EAE5B,MAAM,MAAM,UAAU,MAAM,KAAK,WAAW;GAC1C,MAAM,WAAW,gBAAgB,KAAK,KAAK,SAAS,SAAS;GAC7D,IAAI,UACF,KAAK,MAAM;QACN,IAAI,QAAQ,KAAA,KAAa,QAC9B,OAAO,SAAS,OAAO,KAAK,CAAC;EAEjC,CAAC;CACH;AACF;;;;;AAMA,eAAsB,eACpB,UACA,SACA,WACiB;CACjB,MAAM,SAAS,MAAM,UAAU,QAAQ;EACrC,OAAO;EACP,MAAM;GACJ;GACA;EACF;CACF,CAAC;CACD,OAAO,OAAO,MAAM;AACtB;;;;;;ACpDA,MAAa,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AC+BjC,SAAgB,oBACd,SAKe;CACf,MAAM,EAAE,QAAQ,WAAW,aAAa,GAAG,SAAS;CAEpD,OAAO,EACL,MAAM,IAAI,SAAS;EACjB,IAAI,CAAC,QAAQ,OAAO,IAAI,SAAS,wCAAwC,EAAE,QAAQ,IAAI,CAAC;EACxF,MAAM,OAAO,QAAQ,QAAQ,IAAI,eAAe;EAChD,IAAI,MAAM,QAAQ,eAAe,EAAE,MAAM,QACvC,OAAO,IAAI,SAAS,gBAAgB,EAAE,QAAQ,OAAO,MAAM,IAAI,CAAC;EAElE,MAAM,SAAS,MAAM,WAAW,IAA4B;EAE5D,OAAO,IAAI,SAAS,IAAI,WAAW,MAAM,GAAG,EAC1C,SAAS;GACP,gBAAgB;GAChB,uBAAuB,yBAAyB,SAAS;EAC3D,EACF,CAAC;CACH,EACF;AACF;;;;AAKA,SAAS,WAAW,MAAY,KAAqB;CACnD,IAAI,KAAK,cACP,OAAO,KAAK,QAAQ,KAAK,YAAY;CAEvC,OAAO,KAAK,QAAQ,KAAK,KAAK,QAAQ,KAAK,IAAI,CAAC;AAClD;;;;AAKA,SAAS,iBACP,OACA,KACA,WACoB;CACpB,IAAI,CAAC,OAAO,OAAO,KAAA;CACnB,IAAI,MAAM,WAAW,SAAS,KAAK,MAAM,WAAW,SAAS,KAAK,MAAM,WAAW,UAAU,GAC3F,OAAO;CACT,IAAI,MAAM,WAAW,GAAG,GAAG;EACzB,MAAM,OAAO,aAAa,KAAK,KAAK,KAAK,QAAQ;EACjD,OAAO,cAAc,KAAK,KAAK,MAAM,MAAM,MAAM,CAAC,CAAC,CAAC;CACtD;CACA,OAAO,cAAc,KAAK,QAAQ,KAAK,KAAK,CAAC;AAC/C;AAEA,SAAS,cAAc,UAA0B;CAC/C,OAAO,cAAc,QAAQ,CAAC,CAAC;AACjC;;;;;;;;;;;;;;;;;;;;AAqBA,eAAsB,WACpB,SACiB;CACjB,MAAM,MAAM,QAAQ,IAAI;CACxB,MAAM,EACJ,QAAQ,OACR,cAAc,OAAO,SAAS;EAC5B,IAAI;GACF,OAAO,MAAO,KAAK,KAAwD,QAAQ,KAAK;EAC1F,QAAQ;GACN,QAAQ,KACN,8CAA8C,KAAK,gBAAgB,KAAK,KAAK,4CAC/E;EACF;CACF,GACA,OACA,SAAS,aACT,aACA,WAAW,MACX,YAAY,aACZ,OACA,YACA,cACA,cACA,KACA,YAAY,KAAK,QAAQ,QAAQ,MAC/B;CAEJ,MAAM,SAAS,OAAO,UAAU,aAAa,MAAM,MAAM,IAAI;CAG7D,MAAM,eAAe,oBADJ,OAAO,YACiB,IAAW,SAAS,OAAO,cAAc,IAAI,CAAC,CAAC,CAAC,QACtF,MAAiB,KAAK,IACzB;CAMA,MAAM,iBAHQ,aAAa,SAAS,IAAI,eAAe,OAAO,SAAS,EAAA,CAG3C,QAAQ,SAAS;EAC3C,IAAI,gBAAgB,CAAC,aAAa,IAAI,GAAG,OAAO;EAChD,IAAI,gBAAgB,aAAa,IAAI,GAAG,OAAO;EAC/C,OAAO;CACT,CAAC;CAED,MAAM,WAAiD,CAAC;CAExD,KAAK,MAAM,QAAQ,eAAe;EAChC,MAAM,WAAW,MAAM,YAAY,IAAI;EACvC,IAAI,CAAC,UAAU;EAGf,MAAM,OAAO,MAAM,eAAe,UADlB,WAAW,MAAM,GACW,GAAS,SAAS;EAC9D,MAAM,YAAY,KAAK,KAAK,SAAS,KAAK,MAAM,KAAK,MAAM,SAAS,MAAM;EAE1E,SAAS,KAAK;GACZ,OAAO;GACP,SAAS;EACX,CAAC;CACH;CAEA,MAAM,cAAuB;EAC3B;EACA,QAAQ,MAAM,QAAQ,MAAM,IAAI,SAAS,CAAC,MAAM;EAChD;EACA,MAAM;EACN;EACA,OAAO,iBAAiB,OAAO,KAAK,SAAS,KAAK;EAClD,KAAK,OAAO;EACZ,sBAAsB;EACtB,qBAAqB;EACrB,UAAU;CACZ;CAEA,MAAM,UAAU,SAAS,KAAK,QAAQ;EACpC,OAAO,GAAG;EACV,SAAS,GAAG;CACd,EAAE;CAEF,MAAM,SAAS,MAAM,KAAK,aAAa,OAAO;CAE9C,IAAI,YAAY;EACd,MAAM,KAAK,MAAM,OAAO;EACxB,MAAM,GAAG,MAAM,KAAK,QAAQ,UAAU,GAAG,EAAE,WAAW,KAAK,CAAC;EAC5D,MAAM,GAAG,UAAU,YAAY,MAAM;CACvC;CACA,OAAO;AACT"}
1
+ {"version":3,"file":"index.js","names":[],"sources":["../src/toc-builder.ts","../src/image-resolver.ts","../src/markdown-to-html.ts","../src/default-styles.ts","../src/index.ts"],"sourcesContent":["import type * as PageTree from 'fumadocs-core/page-tree';\nimport { flattenTree } from 'fumadocs-core/page-tree';\n\n/**\n * Get pages in the order they appear in the page tree (navigation order).\n * Uses flattenTree to traverse the tree depth-first, resolving each Item to a page.\n */\nexport function getPagesInTreeOrder<Page>(\n pageTree: PageTree.Root,\n getNodePage: (node: PageTree.Item) => Page | undefined,\n): Page[] {\n const mainItems = flattenTree(pageTree.children);\n const fallbackItems = pageTree.fallback ? flattenTree(pageTree.fallback.children) : [];\n const items = [...mainItems, ...fallbackItems];\n const pages: Page[] = [];\n\n for (const item of items) {\n const page = getNodePage(item);\n if (page) {\n pages.push(page);\n }\n }\n\n return pages;\n}\n","import path from 'node:path';\nimport { pathToFileURL } from 'node:url';\nimport fs from 'node:fs';\n\n/**\n * Resolve image src to file:// URL for epub-gen-memory to embed.\n * Handles relative paths (resolved from page dir), absolute paths, and remote URLs.\n */\nexport function resolveImageSrc(\n src: string,\n pageDir: string,\n publicDir: string,\n): string | undefined {\n // Already a file:// URL\n if (src.startsWith('file://')) {\n return src;\n }\n\n // Remote URL - epub-gen-memory can fetch these\n if (src.startsWith('http://') || src.startsWith('https://')) {\n return src;\n }\n\n // Data URL - pass through\n if (src.startsWith('data:')) {\n return src;\n }\n\n // Protocol-relative URL (//cdn.example.com/...) - normalize to https:\n if (src.startsWith('//')) {\n return `https:${src}`;\n }\n\n // Absolute path starting with / - could be from public dir\n if (src.startsWith('/')) {\n const resolved = path.join(publicDir, src.slice(1));\n if (fs.existsSync(resolved)) return pathToFileURL(resolved).href;\n }\n // Relative path or others - resolve from page directory\n const resolved = path.resolve(pageDir, src);\n if (fs.existsSync(resolved)) return pathToFileURL(resolved).href;\n}\n","import type { Transformer } from 'unified';\nimport remarkGfm from 'remark-gfm';\nimport remarkRehype from 'remark-rehype';\nimport rehypeStringify from 'rehype-stringify';\nimport type { Root, RootContent } from 'mdast';\nimport { remark } from 'remark';\nimport { resolveImageSrc } from './image-resolver';\n\nconst processor = remark()\n .use(remarkGfm)\n .use(remarkResolveImg)\n .use(remarkRehype, { allowDangerousHtml: true })\n .use(rehypeStringify, { allowDangerousHtml: true });\n\ndeclare module 'vfile' {\n export interface DataMap {\n pageDir: string;\n publicDir: string;\n }\n}\n\nfunction remarkResolveImg(): Transformer<Root, Root> {\n return (tree, file) => {\n const { pageDir, publicDir } = file.data;\n if (!pageDir || !publicDir) return;\n\n const visit = (parent: Root | RootContent) => {\n if (!('children' in parent)) return;\n for (let i = 0; i < parent.children.length; i++) {\n const node = parent.children[i];\n if (node.type !== 'image') {\n visit(node);\n continue;\n }\n\n const resolved = resolveImageSrc(node.url, pageDir, publicDir);\n if (resolved) node.url = resolved;\n else parent.children.splice(i--, 1);\n }\n };\n visit(tree);\n };\n}\n\n/**\n * Convert markdown string to HTML suitable for EPUB chapters.\n * Uses unified pipeline: remark-parse -> remark-gfm -> remark-rehype -> rehype-stringify\n */\nexport async function markdownToHtml(\n markdown: string,\n pageDir: string,\n publicDir: string,\n): Promise<string> {\n const result = await processor.process({\n value: markdown,\n data: {\n pageDir,\n publicDir,\n },\n });\n return String(result);\n}\n","/**\n * Minimal, readable CSS stylesheet suitable for e-readers.\n */\nexport const defaultEpubStyles = `\nbody {\n font-family: Georgia, serif;\n font-size: 1em;\n line-height: 1.6;\n margin: 1em;\n}\n\nh1, h2, h3, h4, h5, h6 {\n font-family: Georgia, serif;\n margin-top: 1.5em;\n margin-bottom: 0.5em;\n page-break-after: avoid;\n}\n\nh1 { font-size: 1.5em; }\nh2 { font-size: 1.3em; }\nh3 { font-size: 1.15em; }\n\npre, code {\n font-family: \"Consolas\", \"Monaco\", \"Courier New\", monospace;\n font-size: 0.9em;\n}\n\npre {\n background: #f5f5f5;\n padding: 1em;\n overflow-x: auto;\n page-break-inside: avoid;\n}\n\ncode {\n background: #f5f5f5;\n padding: 0.2em 0.4em;\n}\n\npre code {\n background: none;\n padding: 0;\n}\n\nimg {\n max-width: 100%;\n height: auto;\n}\n\nblockquote {\n margin: 1em 0;\n padding-left: 1em;\n border-left: 4px solid #ccc;\n color: #555;\n}\n\ntable {\n border-collapse: collapse;\n width: 100%;\n page-break-inside: avoid;\n}\n\nth, td {\n border: 1px solid #ddd;\n padding: 0.5em;\n}\n\nth {\n background: #f5f5f5;\n}\n\np {\n margin: 0.75em 0;\n}\n\nul, ol {\n margin: 0.75em 0;\n padding-left: 1.5em;\n}\n\na {\n color: #0066cc;\n}\n`;\n","import epub, { type Options } from 'epub-gen-memory';\nimport path from 'node:path';\nimport { pathToFileURL } from 'node:url';\nimport type { LoaderConfig, Page } from 'fumadocs-core/source';\nimport { getPagesInTreeOrder } from './toc-builder';\nimport { markdownToHtml } from './markdown-to-html';\nimport { defaultEpubStyles } from './default-styles';\nimport type { EpubExportOptions } from './types';\n\nexport { defaultEpubStyles } from './default-styles';\nexport type { EpubConfig, EpubExportOptions } from './types';\n\nexport interface EpubExportAPI {\n GET: (request: Request) => Promise<Response>;\n}\n\n/**\n * A route handler that exports the docs as an EPUB file.\n *\n * The route is guarded by `secret`: it is rejected entirely when the secret is unset (e.g. a missing\n * environment variable), otherwise the request must carry `Authorization: Bearer <secret>`.\n *\n * @example\n * ```ts\n * import { createEpubExportAPI } from 'fumadocs-epub';\n * import { source } from '@/lib/source';\n *\n * export const { GET } = createEpubExportAPI({\n * source,\n * title: 'Documentation',\n * secret: process.env.EXPORT_SECRET,\n * });\n * ```\n */\nexport function createEpubExportAPI<C extends LoaderConfig>(\n options: EpubExportOptions<C> & {\n secret: string | undefined;\n /** @defaultValue 'docs.epub' */\n filename?: string;\n },\n): EpubExportAPI {\n const { secret, filename = 'docs.epub', ...rest } = options;\n\n return {\n async GET(request) {\n if (!secret) return new Response('the export secret is not configured.', { status: 503 });\n const auth = request.headers.get('authorization');\n if (auth?.replace(/^Bearer\\s+/i, '') !== secret)\n return new Response('Unauthorized', { status: auth ? 403 : 401 });\n\n const buffer = await exportEpub(rest as EpubExportOptions<C>);\n\n return new Response(new Uint8Array(buffer), {\n headers: {\n 'Content-Type': 'application/epub+zip',\n 'Content-Disposition': `attachment; filename=\"${filename}\"`,\n },\n });\n },\n };\n}\n\n/**\n * Get page directory for resolving relative image paths\n */\nfunction getPageDir(page: Page, cwd: string): string {\n if (page.absolutePath) {\n return path.dirname(page.absolutePath);\n }\n return path.resolve(cwd, path.dirname(page.path));\n}\n\n/**\n * Resolve cover image path - support file://, http(s)://, /public/..., or relative\n */\nfunction resolveCoverPath(\n cover: string | undefined,\n cwd: string,\n publicDir?: string,\n): string | undefined {\n if (!cover) return undefined;\n if (cover.startsWith('file://') || cover.startsWith('http://') || cover.startsWith('https://'))\n return cover;\n if (cover.startsWith('/')) {\n const base = publicDir ?? path.join(cwd, 'public');\n return pathToFileUrl(path.join(base, cover.slice(1)));\n }\n return pathToFileUrl(path.resolve(cwd, cover));\n}\n\nfunction pathToFileUrl(filePath: string): string {\n return pathToFileURL(filePath).href;\n}\n\n/**\n * Export Fumadocs documentation to EPUB format.\n *\n * @param options - Export configuration with source and epub config\n * @returns Promise resolving to the EPUB file as a Buffer\n *\n * @example\n * ```ts\n * import { exportEpub } from 'fumadocs-epub';\n * import { source } from '@/lib/source';\n *\n * const buffer = await exportEpub({\n * source,\n * title: 'My Documentation',\n * author: 'My Team',\n * cover: '/cover.png',\n * });\n * ```\n */\nexport async function exportEpub<C extends LoaderConfig>(\n options: EpubExportOptions<C>,\n): Promise<Buffer> {\n const cwd = process.cwd();\n const {\n source: input,\n getMarkdown = async (page) => {\n try {\n return await (page.data as { getText: (type: string) => Promise<string> }).getText('raw');\n } catch {\n console.warn(\n `Failed to get processed markdown for page \"${page.absolutePath ?? page.path}\", please specify the \"getMarkdown\" option.`,\n );\n }\n },\n title,\n author = 'anonymous',\n description,\n language = 'en',\n publisher = 'anonymous',\n cover,\n outputPath,\n includePages,\n excludePages,\n css,\n publicDir = path.resolve('public'),\n } = options;\n\n const source = typeof input === 'function' ? await input() : input;\n // Get pages in tree order (navigation order)\n const pageTree = source.getPageTree();\n const orderedPages = getPagesInTreeOrder(pageTree, (node) => source.getNodePage?.(node)).filter(\n (p): p is Page => p != null,\n );\n\n // Fallback to getPages() if tree order yields no pages (e.g. i18n)\n const pages = orderedPages.length > 0 ? orderedPages : source.getPages();\n\n // Filter pages\n const filteredPages = pages.filter((page) => {\n if (includePages && !includePages(page)) return false;\n if (excludePages && excludePages(page)) return false;\n return true;\n });\n\n const chapters: { title: string; content: string }[] = [];\n\n for (const page of filteredPages) {\n const markdown = await getMarkdown(page);\n if (!markdown) continue;\n\n const pageDir = getPageDir(page, cwd);\n const html = await markdownToHtml(markdown, pageDir, publicDir);\n const pageTitle = page.data.title ?? page.slugs[page.slugs.length - 1] ?? 'Untitled';\n\n chapters.push({\n title: pageTitle,\n content: html,\n });\n }\n\n const epubOptions: Options = {\n title,\n author: Array.isArray(author) ? author : [author],\n description,\n lang: language,\n publisher,\n cover: resolveCoverPath(cover, cwd, publicDir) ?? cover,\n css: css ?? defaultEpubStyles,\n prependChapterTitles: true,\n numberChaptersInTOC: true,\n tocTitle: 'Table of Contents',\n };\n\n const content = chapters.map((ch) => ({\n title: ch.title,\n content: ch.content,\n }));\n\n const buffer = await epub(epubOptions, content);\n\n if (outputPath) {\n const fs = await import('node:fs/promises');\n await fs.mkdir(path.dirname(outputPath), { recursive: true });\n await fs.writeFile(outputPath, buffer);\n }\n return buffer;\n}\n"],"mappings":";;;;;;;;;;;;;;AAOA,SAAgB,oBACd,UACA,aACQ;CACR,MAAM,YAAY,YAAY,SAAS,QAAQ;CAC/C,MAAM,gBAAgB,SAAS,WAAW,YAAY,SAAS,SAAS,QAAQ,IAAI,CAAC;CACrF,MAAM,QAAQ,CAAC,GAAG,WAAW,GAAG,aAAa;CAC7C,MAAM,QAAgB,CAAC;CAEvB,KAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,OAAO,YAAY,IAAI;EAC7B,IAAI,MACF,MAAM,KAAK,IAAI;CAEnB;CAEA,OAAO;AACT;;;;;;;AChBA,SAAgB,gBACd,KACA,SACA,WACoB;CAEpB,IAAI,IAAI,WAAW,SAAS,GAC1B,OAAO;CAIT,IAAI,IAAI,WAAW,SAAS,KAAK,IAAI,WAAW,UAAU,GACxD,OAAO;CAIT,IAAI,IAAI,WAAW,OAAO,GACxB,OAAO;CAIT,IAAI,IAAI,WAAW,IAAI,GACrB,OAAO,SAAS;CAIlB,IAAI,IAAI,WAAW,GAAG,GAAG;EACvB,MAAM,WAAW,KAAK,KAAK,WAAW,IAAI,MAAM,CAAC,CAAC;EAClD,IAAI,GAAG,WAAW,QAAQ,GAAG,OAAO,cAAc,QAAQ,CAAC,CAAC;CAC9D;CAEA,MAAM,WAAW,KAAK,QAAQ,SAAS,GAAG;CAC1C,IAAI,GAAG,WAAW,QAAQ,GAAG,OAAO,cAAc,QAAQ,CAAC,CAAC;AAC9D;;;ACjCA,MAAM,YAAY,OAAO,CAAC,CACvB,IAAI,SAAS,CAAC,CACd,IAAI,gBAAgB,CAAC,CACrB,IAAI,cAAc,EAAE,oBAAoB,KAAK,CAAC,CAAC,CAC/C,IAAI,iBAAiB,EAAE,oBAAoB,KAAK,CAAC;AASpD,SAAS,mBAA4C;CACnD,QAAQ,MAAM,SAAS;EACrB,MAAM,EAAE,SAAS,cAAc,KAAK;EACpC,IAAI,CAAC,WAAW,CAAC,WAAW;EAE5B,MAAM,SAAS,WAA+B;GAC5C,IAAI,EAAE,cAAc,SAAS;GAC7B,KAAK,IAAI,IAAI,GAAG,IAAI,OAAO,SAAS,QAAQ,KAAK;IAC/C,MAAM,OAAO,OAAO,SAAS;IAC7B,IAAI,KAAK,SAAS,SAAS;KACzB,MAAM,IAAI;KACV;IACF;IAEA,MAAM,WAAW,gBAAgB,KAAK,KAAK,SAAS,SAAS;IAC7D,IAAI,UAAU,KAAK,MAAM;SACpB,OAAO,SAAS,OAAO,KAAK,CAAC;GACpC;EACF;EACA,MAAM,IAAI;CACZ;AACF;;;;;AAMA,eAAsB,eACpB,UACA,SACA,WACiB;CACjB,MAAM,SAAS,MAAM,UAAU,QAAQ;EACrC,OAAO;EACP,MAAM;GACJ;GACA;EACF;CACF,CAAC;CACD,OAAO,OAAO,MAAM;AACtB;;;;;;AC1DA,MAAa,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AC+BjC,SAAgB,oBACd,SAKe;CACf,MAAM,EAAE,QAAQ,WAAW,aAAa,GAAG,SAAS;CAEpD,OAAO,EACL,MAAM,IAAI,SAAS;EACjB,IAAI,CAAC,QAAQ,OAAO,IAAI,SAAS,wCAAwC,EAAE,QAAQ,IAAI,CAAC;EACxF,MAAM,OAAO,QAAQ,QAAQ,IAAI,eAAe;EAChD,IAAI,MAAM,QAAQ,eAAe,EAAE,MAAM,QACvC,OAAO,IAAI,SAAS,gBAAgB,EAAE,QAAQ,OAAO,MAAM,IAAI,CAAC;EAElE,MAAM,SAAS,MAAM,WAAW,IAA4B;EAE5D,OAAO,IAAI,SAAS,IAAI,WAAW,MAAM,GAAG,EAC1C,SAAS;GACP,gBAAgB;GAChB,uBAAuB,yBAAyB,SAAS;EAC3D,EACF,CAAC;CACH,EACF;AACF;;;;AAKA,SAAS,WAAW,MAAY,KAAqB;CACnD,IAAI,KAAK,cACP,OAAO,KAAK,QAAQ,KAAK,YAAY;CAEvC,OAAO,KAAK,QAAQ,KAAK,KAAK,QAAQ,KAAK,IAAI,CAAC;AAClD;;;;AAKA,SAAS,iBACP,OACA,KACA,WACoB;CACpB,IAAI,CAAC,OAAO,OAAO,KAAA;CACnB,IAAI,MAAM,WAAW,SAAS,KAAK,MAAM,WAAW,SAAS,KAAK,MAAM,WAAW,UAAU,GAC3F,OAAO;CACT,IAAI,MAAM,WAAW,GAAG,GAAG;EACzB,MAAM,OAAO,aAAa,KAAK,KAAK,KAAK,QAAQ;EACjD,OAAO,cAAc,KAAK,KAAK,MAAM,MAAM,MAAM,CAAC,CAAC,CAAC;CACtD;CACA,OAAO,cAAc,KAAK,QAAQ,KAAK,KAAK,CAAC;AAC/C;AAEA,SAAS,cAAc,UAA0B;CAC/C,OAAO,cAAc,QAAQ,CAAC,CAAC;AACjC;;;;;;;;;;;;;;;;;;;;AAqBA,eAAsB,WACpB,SACiB;CACjB,MAAM,MAAM,QAAQ,IAAI;CACxB,MAAM,EACJ,QAAQ,OACR,cAAc,OAAO,SAAS;EAC5B,IAAI;GACF,OAAO,MAAO,KAAK,KAAwD,QAAQ,KAAK;EAC1F,QAAQ;GACN,QAAQ,KACN,8CAA8C,KAAK,gBAAgB,KAAK,KAAK,4CAC/E;EACF;CACF,GACA,OACA,SAAS,aACT,aACA,WAAW,MACX,YAAY,aACZ,OACA,YACA,cACA,cACA,KACA,YAAY,KAAK,QAAQ,QAAQ,MAC/B;CAEJ,MAAM,SAAS,OAAO,UAAU,aAAa,MAAM,MAAM,IAAI;CAG7D,MAAM,eAAe,oBADJ,OAAO,YACiB,IAAW,SAAS,OAAO,cAAc,IAAI,CAAC,CAAC,CAAC,QACtF,MAAiB,KAAK,IACzB;CAMA,MAAM,iBAHQ,aAAa,SAAS,IAAI,eAAe,OAAO,SAAS,EAAA,CAG3C,QAAQ,SAAS;EAC3C,IAAI,gBAAgB,CAAC,aAAa,IAAI,GAAG,OAAO;EAChD,IAAI,gBAAgB,aAAa,IAAI,GAAG,OAAO;EAC/C,OAAO;CACT,CAAC;CAED,MAAM,WAAiD,CAAC;CAExD,KAAK,MAAM,QAAQ,eAAe;EAChC,MAAM,WAAW,MAAM,YAAY,IAAI;EACvC,IAAI,CAAC,UAAU;EAGf,MAAM,OAAO,MAAM,eAAe,UADlB,WAAW,MAAM,GACW,GAAS,SAAS;EAC9D,MAAM,YAAY,KAAK,KAAK,SAAS,KAAK,MAAM,KAAK,MAAM,SAAS,MAAM;EAE1E,SAAS,KAAK;GACZ,OAAO;GACP,SAAS;EACX,CAAC;CACH;CAEA,MAAM,cAAuB;EAC3B;EACA,QAAQ,MAAM,QAAQ,MAAM,IAAI,SAAS,CAAC,MAAM;EAChD;EACA,MAAM;EACN;EACA,OAAO,iBAAiB,OAAO,KAAK,SAAS,KAAK;EAClD,KAAK,OAAO;EACZ,sBAAsB;EACtB,qBAAqB;EACrB,UAAU;CACZ;CAEA,MAAM,UAAU,SAAS,KAAK,QAAQ;EACpC,OAAO,GAAG;EACV,SAAS,GAAG;CACd,EAAE;CAEF,MAAM,SAAS,MAAM,KAAK,aAAa,OAAO;CAE9C,IAAI,YAAY;EACd,MAAM,KAAK,MAAM,OAAO;EACxB,MAAM,GAAG,MAAM,KAAK,QAAQ,UAAU,GAAG,EAAE,WAAW,KAAK,CAAC;EAC5D,MAAM,GAAG,UAAU,YAAY,MAAM;CACvC;CACA,OAAO;AACT"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fumadocs-epub",
3
- "version": "1.2.2",
3
+ "version": "1.2.3",
4
4
  "description": "EPUB export for Fumadocs documentation",
5
5
  "keywords": [
6
6
  "documentation",
@@ -37,18 +37,17 @@
37
37
  "remark": "^15.0.1",
38
38
  "remark-gfm": "^4.0.1",
39
39
  "remark-rehype": "^11.1.2",
40
- "unified": "^11.0.5",
41
- "unist-util-visit": "^5.1.0"
40
+ "unified": "^11.0.5"
42
41
  },
43
42
  "devDependencies": {
44
43
  "@types/mdast": "^4.0.4",
45
- "@types/node": "26.5.0",
44
+ "@types/node": "26.6.4",
45
+ "fumadocs-core": "16.17.0",
46
46
  "rimraf": "^6.0.0",
47
+ "tsconfig": "0.0.0",
47
48
  "tsdown": "0.23.0",
48
49
  "typescript": "^7.0.2",
49
- "vfile": "^6.0.3",
50
- "fumadocs-core": "16.15.11",
51
- "tsconfig": "0.0.0"
50
+ "vfile": "^6.0.3"
52
51
  },
53
52
  "peerDependencies": {
54
53
  "fumadocs-core": "^16.8.0"