fumadocs-mdx 13.0.8 → 14.0.1

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 (111) hide show
  1. package/dist/bin.cjs +985 -893
  2. package/dist/bin.js +3 -3
  3. package/dist/build-mdx-6UAK5FF5.js +8 -0
  4. package/dist/bun/index.cjs +613 -471
  5. package/dist/bun/index.d.cts +9 -2
  6. package/dist/bun/index.d.ts +9 -2
  7. package/dist/bun/index.js +15 -14
  8. package/dist/chunk-4JSFLXXT.js +8 -0
  9. package/dist/chunk-5OBUOALK.js +141 -0
  10. package/dist/{chunk-2E2JCOSO.js → chunk-6NISOLQ6.js} +16 -44
  11. package/dist/chunk-7UKSZSPY.js +331 -0
  12. package/dist/chunk-BEBCWQC7.js +224 -0
  13. package/dist/chunk-E5DJTSIM.js +86 -0
  14. package/dist/{chunk-K5ZLPEIQ.js → chunk-FBLMK4RS.js} +9 -6
  15. package/dist/chunk-IQGEFL2B.js +17 -0
  16. package/dist/{chunk-5FTSWCB4.js → chunk-K6HCOGOX.js} +9 -11
  17. package/dist/{chunk-QXHN25N3.js → chunk-MTTISKQJ.js} +6 -6
  18. package/dist/{chunk-3J3WL7WN.js → chunk-SLY7WXTX.js} +71 -58
  19. package/dist/chunk-TYJDYTKH.js +85 -0
  20. package/dist/chunk-WBIHDYMN.js +126 -0
  21. package/dist/{chunk-2HXTGJBI.js → chunk-ZY6UZ7NH.js} +22 -19
  22. package/dist/config/index.cjs +79 -71
  23. package/dist/config/index.d.cts +7 -1
  24. package/dist/config/index.d.ts +7 -1
  25. package/dist/config/index.js +5 -5
  26. package/dist/core-B9ZoS6sA.d.ts +341 -0
  27. package/dist/core-DTuP23zu.d.cts +341 -0
  28. package/dist/index-BD8Woo4m.d.cts +8 -0
  29. package/dist/index-CNOvhtOn.d.ts +8 -0
  30. package/dist/index.d.cts +38 -56
  31. package/dist/index.d.ts +38 -56
  32. package/dist/load-from-file-5HUQN36V.js +8 -0
  33. package/dist/next/index.cjs +763 -473
  34. package/dist/next/index.d.cts +16 -1
  35. package/dist/next/index.d.ts +16 -1
  36. package/dist/next/index.js +80 -281
  37. package/dist/node/loader.cjs +764 -627
  38. package/dist/node/loader.js +10 -11
  39. package/dist/plugins/index-file.cjs +495 -0
  40. package/dist/plugins/index-file.d.cts +14 -0
  41. package/dist/plugins/index-file.d.ts +14 -0
  42. package/dist/plugins/index-file.js +8 -0
  43. package/dist/plugins/json-schema.d.cts +9 -2
  44. package/dist/plugins/json-schema.d.ts +9 -2
  45. package/dist/plugins/last-modified.cjs +110 -0
  46. package/dist/plugins/last-modified.d.cts +37 -0
  47. package/dist/plugins/last-modified.d.ts +37 -0
  48. package/dist/plugins/last-modified.js +74 -0
  49. package/dist/runtime/browser.cjs +93 -0
  50. package/dist/runtime/browser.d.cts +53 -0
  51. package/dist/runtime/browser.d.ts +53 -0
  52. package/dist/runtime/browser.js +67 -0
  53. package/dist/runtime/dynamic.cjs +1023 -0
  54. package/dist/runtime/dynamic.d.cts +27 -0
  55. package/dist/runtime/dynamic.d.ts +27 -0
  56. package/dist/runtime/dynamic.js +79 -0
  57. package/dist/runtime/server.cjs +176 -0
  58. package/dist/runtime/server.d.cts +14 -0
  59. package/dist/runtime/server.d.ts +14 -0
  60. package/dist/runtime/server.js +8 -0
  61. package/dist/runtime/types.cjs +18 -0
  62. package/dist/runtime/types.d.cts +61 -0
  63. package/dist/runtime/types.d.ts +61 -0
  64. package/dist/runtime/types.js +0 -0
  65. package/dist/vite/index.cjs +984 -621
  66. package/dist/vite/index.d.cts +17 -22
  67. package/dist/vite/index.d.ts +17 -22
  68. package/dist/vite/index.js +32 -222
  69. package/dist/webpack/mdx.cjs +647 -514
  70. package/dist/webpack/mdx.d.cts +15 -1
  71. package/dist/webpack/mdx.d.ts +15 -1
  72. package/dist/webpack/mdx.js +12 -17
  73. package/dist/webpack/meta.cjs +360 -231
  74. package/dist/webpack/meta.d.cts +15 -1
  75. package/dist/webpack/meta.d.ts +15 -1
  76. package/dist/webpack/meta.js +13 -15
  77. package/package.json +15 -32
  78. package/dist/build-mdx-BjXOmv0b.d.cts +0 -53
  79. package/dist/build-mdx-CY5UldCO.d.ts +0 -53
  80. package/dist/chunk-2AQRQXSO.js +0 -119
  81. package/dist/chunk-CXA4JO4Z.js +0 -45
  82. package/dist/chunk-DMJ6I4C3.js +0 -76
  83. package/dist/chunk-FSZMKRVH.js +0 -80
  84. package/dist/chunk-II3H5ZVZ.js +0 -77
  85. package/dist/chunk-KILFIBVW.js +0 -75
  86. package/dist/chunk-NVRDCY6Z.js +0 -30
  87. package/dist/chunk-VUEZTR2H.js +0 -26
  88. package/dist/core-DB7TdlyC.d.cts +0 -234
  89. package/dist/core-DB7TdlyC.d.ts +0 -234
  90. package/dist/index-D7s7kCc2.d.cts +0 -7
  91. package/dist/index-D7s7kCc2.d.ts +0 -7
  92. package/dist/load-from-file-AVYOFOI7.js +0 -7
  93. package/dist/preset-ZMP6U62C.js +0 -6
  94. package/dist/runtime/next/async.cjs +0 -760
  95. package/dist/runtime/next/async.d.cts +0 -19
  96. package/dist/runtime/next/async.d.ts +0 -19
  97. package/dist/runtime/next/async.js +0 -86
  98. package/dist/runtime/next/index.cjs +0 -136
  99. package/dist/runtime/next/index.d.cts +0 -33
  100. package/dist/runtime/next/index.d.ts +0 -33
  101. package/dist/runtime/next/index.js +0 -11
  102. package/dist/runtime/vite/browser.cjs +0 -107
  103. package/dist/runtime/vite/browser.d.cts +0 -59
  104. package/dist/runtime/vite/browser.d.ts +0 -59
  105. package/dist/runtime/vite/browser.js +0 -11
  106. package/dist/runtime/vite/server.cjs +0 -243
  107. package/dist/runtime/vite/server.d.cts +0 -30
  108. package/dist/runtime/vite/server.d.ts +0 -30
  109. package/dist/runtime/vite/server.js +0 -111
  110. package/dist/types-Bnh9n7mj.d.cts +0 -45
  111. package/dist/types-ey1AZqrg.d.ts +0 -45
@@ -0,0 +1,8 @@
1
+ import { i as CoreOptions } from './core-DTuP23zu.cjs';
2
+
3
+ interface WebpackLoaderOptions extends CoreOptions {
4
+ compiledConfigPath: string;
5
+ isDev: boolean;
6
+ }
7
+
8
+ export type { WebpackLoaderOptions as W };
@@ -0,0 +1,8 @@
1
+ import { i as CoreOptions } from './core-B9ZoS6sA.js';
2
+
3
+ interface WebpackLoaderOptions extends CoreOptions {
4
+ compiledConfigPath: string;
5
+ isDev: boolean;
6
+ }
7
+
8
+ export type { WebpackLoaderOptions as W };
package/dist/index.d.cts CHANGED
@@ -1,79 +1,61 @@
1
+ export { p as CompilationContext, u as Core, i as CoreOptions, n as EmitEntry, s as EmitOptions, E as ExtractedReference, j as Plugin, o as PluginContext, q as PluginOption, r as ServerContext, T as TransformOptions, _ as _Defaults, t as createCore } from './core-DTuP23zu.cjs';
2
+ import { createProcessor } from '@mdx-js/mdx';
1
3
  import { StructuredData } from 'fumadocs-core/mdx-plugins';
2
4
  import { TOCItemType } from 'fumadocs-core/toc';
3
- import { MDXContent } from 'mdx/types';
4
- import { E as ExtractedReference } from './core-DB7TdlyC.cjs';
5
- export { r as Core, C as CoreOptions, k as EmitEntry, o as EmitOptions, i as Plugin, l as PluginContext, n as PluginOption, S as ServerContext, q as createCore, p as findConfigFile } from './core-DB7TdlyC.cjs';
6
- import { Root } from 'mdast';
7
- import { C as CompiledMDXProperties } from './build-mdx-BjXOmv0b.cjs';
8
- import '@mdx-js/mdx';
5
+ import { FC } from 'react';
6
+ import { MDXProps } from 'mdx/types';
9
7
  import '@standard-schema/spec';
10
8
  import 'unified';
11
9
  import 'zod';
12
10
  import 'chokidar';
13
- import 'react';
11
+ import 'vfile';
12
+ import 'fumadocs-core/source';
13
+ import './runtime/types.cjs';
14
+ import 'fumadocs-core/mdx-plugins/remark-structure';
15
+ import 'mdast';
14
16
 
15
- interface FileInfo {
16
- /**
17
- * virtualized path for Source API
18
- */
19
- path: string;
20
- /**
21
- * the file path in file system
22
- */
23
- fullPath: string;
17
+ type Processor = ReturnType<typeof createProcessor>;
18
+ interface CompilerOptions {
19
+ addDependency: (file: string) => void;
24
20
  }
25
- interface DocData {
26
- /**
27
- * Compiled MDX content (as component)
28
- */
29
- body: MDXContent;
30
- /**
31
- * table of contents generated from content.
32
- */
21
+ interface CompiledMDXProperties<Frontmatter = Record<string, unknown>> {
22
+ frontmatter: Frontmatter;
23
+ structuredData: StructuredData;
33
24
  toc: TOCItemType[];
25
+ default: FC<MDXProps>;
34
26
  /**
35
- * structured data for document search indexing.
27
+ * Enable from `postprocess` option.
36
28
  */
37
- structuredData: StructuredData;
29
+ _markdown?: string;
38
30
  /**
39
- * Raw exports from the compiled MDX file.
31
+ * Enable from `postprocess` option.
40
32
  */
41
- _exports: Record<string, unknown>;
33
+ _mdast?: string;
34
+ }
35
+ interface FumadocsDataMap {
42
36
  /**
43
- * Last modified date of document file, obtained from version control.
44
- *
45
- * Only available when `lastModifiedTime` is enabled on global config.
37
+ * [Fumadocs MDX] raw frontmatter, you can modify it
46
38
  */
47
- lastModified?: Date;
39
+ frontmatter?: Record<string, unknown>;
48
40
  /**
49
- * extracted references (e.g. hrefs, paths), useful for analyzing relationships between pages.
41
+ * [Fumadocs MDX] additional ESM exports to write
50
42
  */
51
- extractedReferences?: ExtractedReference[];
52
- }
53
- interface DocMethods {
43
+ 'mdx-export'?: {
44
+ name: string;
45
+ value: unknown;
46
+ }[];
54
47
  /**
55
- * file info
48
+ * [Fumadocs MDX] The compiler object from loader
56
49
  */
57
- info: FileInfo;
50
+ _compiler?: CompilerOptions;
58
51
  /**
59
- * get document as text.
60
- *
61
- * - `type: raw` - read the original content from file system.
62
- * - `type: processed` - get the processed Markdown content, only available when `includeProcessedMarkdown` is enabled on collection config.
52
+ * [Fumadocs MDX] get internal processor, do not use this on user land.
63
53
  */
64
- getText: (type: 'raw' | 'processed') => Promise<string>;
65
- getMDAST: () => Promise<Root>;
54
+ _getProcessor?: (format: 'md' | 'mdx') => Processor;
55
+ }
56
+ declare module 'vfile' {
57
+ interface DataMap extends FumadocsDataMap {
58
+ }
66
59
  }
67
- type MetaCollectionEntry<Data> = Data & {
68
- /**
69
- * file info
70
- */
71
- info: FileInfo;
72
- };
73
- type DocCollectionEntry<Frontmatter> = DocData & DocMethods & Frontmatter;
74
- type AsyncDocCollectionEntry<Frontmatter> = DocMethods & {
75
- load: () => Promise<DocData>;
76
- } & Frontmatter;
77
- declare function createDocMethods(info: FileInfo, load: () => Promise<CompiledMDXProperties<any>>): DocMethods;
78
60
 
79
- export { type AsyncDocCollectionEntry, type DocCollectionEntry, type DocData, type DocMethods, ExtractedReference, type FileInfo, type MetaCollectionEntry, createDocMethods };
61
+ export type { CompiledMDXProperties };
package/dist/index.d.ts CHANGED
@@ -1,79 +1,61 @@
1
+ export { p as CompilationContext, u as Core, i as CoreOptions, n as EmitEntry, s as EmitOptions, E as ExtractedReference, j as Plugin, o as PluginContext, q as PluginOption, r as ServerContext, T as TransformOptions, _ as _Defaults, t as createCore } from './core-B9ZoS6sA.js';
2
+ import { createProcessor } from '@mdx-js/mdx';
1
3
  import { StructuredData } from 'fumadocs-core/mdx-plugins';
2
4
  import { TOCItemType } from 'fumadocs-core/toc';
3
- import { MDXContent } from 'mdx/types';
4
- import { E as ExtractedReference } from './core-DB7TdlyC.js';
5
- export { r as Core, C as CoreOptions, k as EmitEntry, o as EmitOptions, i as Plugin, l as PluginContext, n as PluginOption, S as ServerContext, q as createCore, p as findConfigFile } from './core-DB7TdlyC.js';
6
- import { Root } from 'mdast';
7
- import { C as CompiledMDXProperties } from './build-mdx-CY5UldCO.js';
8
- import '@mdx-js/mdx';
5
+ import { FC } from 'react';
6
+ import { MDXProps } from 'mdx/types';
9
7
  import '@standard-schema/spec';
10
8
  import 'unified';
11
9
  import 'zod';
12
10
  import 'chokidar';
13
- import 'react';
11
+ import 'vfile';
12
+ import 'fumadocs-core/source';
13
+ import './runtime/types.js';
14
+ import 'fumadocs-core/mdx-plugins/remark-structure';
15
+ import 'mdast';
14
16
 
15
- interface FileInfo {
16
- /**
17
- * virtualized path for Source API
18
- */
19
- path: string;
20
- /**
21
- * the file path in file system
22
- */
23
- fullPath: string;
17
+ type Processor = ReturnType<typeof createProcessor>;
18
+ interface CompilerOptions {
19
+ addDependency: (file: string) => void;
24
20
  }
25
- interface DocData {
26
- /**
27
- * Compiled MDX content (as component)
28
- */
29
- body: MDXContent;
30
- /**
31
- * table of contents generated from content.
32
- */
21
+ interface CompiledMDXProperties<Frontmatter = Record<string, unknown>> {
22
+ frontmatter: Frontmatter;
23
+ structuredData: StructuredData;
33
24
  toc: TOCItemType[];
25
+ default: FC<MDXProps>;
34
26
  /**
35
- * structured data for document search indexing.
27
+ * Enable from `postprocess` option.
36
28
  */
37
- structuredData: StructuredData;
29
+ _markdown?: string;
38
30
  /**
39
- * Raw exports from the compiled MDX file.
31
+ * Enable from `postprocess` option.
40
32
  */
41
- _exports: Record<string, unknown>;
33
+ _mdast?: string;
34
+ }
35
+ interface FumadocsDataMap {
42
36
  /**
43
- * Last modified date of document file, obtained from version control.
44
- *
45
- * Only available when `lastModifiedTime` is enabled on global config.
37
+ * [Fumadocs MDX] raw frontmatter, you can modify it
46
38
  */
47
- lastModified?: Date;
39
+ frontmatter?: Record<string, unknown>;
48
40
  /**
49
- * extracted references (e.g. hrefs, paths), useful for analyzing relationships between pages.
41
+ * [Fumadocs MDX] additional ESM exports to write
50
42
  */
51
- extractedReferences?: ExtractedReference[];
52
- }
53
- interface DocMethods {
43
+ 'mdx-export'?: {
44
+ name: string;
45
+ value: unknown;
46
+ }[];
54
47
  /**
55
- * file info
48
+ * [Fumadocs MDX] The compiler object from loader
56
49
  */
57
- info: FileInfo;
50
+ _compiler?: CompilerOptions;
58
51
  /**
59
- * get document as text.
60
- *
61
- * - `type: raw` - read the original content from file system.
62
- * - `type: processed` - get the processed Markdown content, only available when `includeProcessedMarkdown` is enabled on collection config.
52
+ * [Fumadocs MDX] get internal processor, do not use this on user land.
63
53
  */
64
- getText: (type: 'raw' | 'processed') => Promise<string>;
65
- getMDAST: () => Promise<Root>;
54
+ _getProcessor?: (format: 'md' | 'mdx') => Processor;
55
+ }
56
+ declare module 'vfile' {
57
+ interface DataMap extends FumadocsDataMap {
58
+ }
66
59
  }
67
- type MetaCollectionEntry<Data> = Data & {
68
- /**
69
- * file info
70
- */
71
- info: FileInfo;
72
- };
73
- type DocCollectionEntry<Frontmatter> = DocData & DocMethods & Frontmatter;
74
- type AsyncDocCollectionEntry<Frontmatter> = DocMethods & {
75
- load: () => Promise<DocData>;
76
- } & Frontmatter;
77
- declare function createDocMethods(info: FileInfo, load: () => Promise<CompiledMDXProperties<any>>): DocMethods;
78
60
 
79
- export { type AsyncDocCollectionEntry, type DocCollectionEntry, type DocData, type DocMethods, ExtractedReference, type FileInfo, type MetaCollectionEntry, createDocMethods };
61
+ export type { CompiledMDXProperties };
@@ -0,0 +1,8 @@
1
+ import {
2
+ loadConfig
3
+ } from "./chunk-MTTISKQJ.js";
4
+ import "./chunk-ZY6UZ7NH.js";
5
+ import "./chunk-E5DJTSIM.js";
6
+ export {
7
+ loadConfig
8
+ };