fumadocs-core 15.7.5 → 15.7.7
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.
- package/dist/breadcrumb.js +2 -2
- package/dist/mdx-plugins/index.d.ts +47 -1
- package/dist/mdx-plugins/index.js +103 -0
- package/package.json +6 -6
package/dist/breadcrumb.js
CHANGED
|
@@ -193,4 +193,50 @@ interface CodeBlockAttributes<Name extends string = string> {
|
|
|
193
193
|
*/
|
|
194
194
|
declare function parseCodeBlockAttributes<Name extends string = string>(meta: string, allowedNames?: Name[]): CodeBlockAttributes<Name>;
|
|
195
195
|
|
|
196
|
-
|
|
196
|
+
interface FileNode {
|
|
197
|
+
depth: number;
|
|
198
|
+
type: 'file';
|
|
199
|
+
name: string;
|
|
200
|
+
}
|
|
201
|
+
interface FolderNode {
|
|
202
|
+
depth: number;
|
|
203
|
+
type: 'folder';
|
|
204
|
+
name: string;
|
|
205
|
+
children: Node[];
|
|
206
|
+
}
|
|
207
|
+
type Node = FileNode | FolderNode;
|
|
208
|
+
interface RemarkMdxFilesOptions {
|
|
209
|
+
/**
|
|
210
|
+
* @defaultValue files
|
|
211
|
+
*/
|
|
212
|
+
lang?: string;
|
|
213
|
+
toMdx?: (node: Node) => MdxJsxFlowElement;
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* Convert codeblocks with `files` as lang, like:
|
|
217
|
+
*
|
|
218
|
+
* ```files
|
|
219
|
+
* project
|
|
220
|
+
* ├── src
|
|
221
|
+
* │ ├── index.js
|
|
222
|
+
* │ └── utils
|
|
223
|
+
* │ └── helper.js
|
|
224
|
+
* ├── package.json
|
|
225
|
+
* ```
|
|
226
|
+
*
|
|
227
|
+
* into MDX `<Files />` component
|
|
228
|
+
*/
|
|
229
|
+
declare function remarkMdxFiles(options?: RemarkMdxFilesOptions): Transformer<Root$1, Root$1>;
|
|
230
|
+
|
|
231
|
+
interface RemarkMdxMermaidOptions {
|
|
232
|
+
/**
|
|
233
|
+
* @defaultValue mermaid
|
|
234
|
+
*/
|
|
235
|
+
lang?: string;
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* Convert `mermaid` codeblocks into `<Mermaid />` MDX component
|
|
239
|
+
*/
|
|
240
|
+
declare function remarkMdxMermaid(options?: RemarkMdxMermaidOptions): Transformer<Root$1, Root$1>;
|
|
241
|
+
|
|
242
|
+
export { type CodeBlockAttributes, type CodeBlockIcon, type CodeBlockTabsOptions, type RehypeCodeOptions, type RehypeTocOptions, type RemarkAdmonitionOptions, type RemarkImageOptions, type RemarkMdxFilesOptions, type RemarkMdxMermaidOptions, type RemarkNpmOptions, type RemarkStepsOptions, generateCodeBlockTabs, parseCodeBlockAttributes, rehypeCode, rehypeCodeDefaultOptions, rehypeToc, remarkAdmonition, remarkImage, remarkMdxFiles, remarkMdxMermaid, remarkNpm, remarkSteps, transformerIcon, transformerTab };
|
|
@@ -1216,6 +1216,107 @@ function remarkNpm({
|
|
|
1216
1216
|
});
|
|
1217
1217
|
};
|
|
1218
1218
|
}
|
|
1219
|
+
|
|
1220
|
+
// src/mdx-plugins/remark-mdx-files.ts
|
|
1221
|
+
import { visit as visit8 } from "unist-util-visit";
|
|
1222
|
+
function parseFileTree(code) {
|
|
1223
|
+
const lines = code.split(/\r?\n/);
|
|
1224
|
+
const stack = /* @__PURE__ */ new Map();
|
|
1225
|
+
for (const line of lines) {
|
|
1226
|
+
let depth = 0;
|
|
1227
|
+
let name = line;
|
|
1228
|
+
let match;
|
|
1229
|
+
while (match = /(?:├──|│|└──)\s*/.exec(name)) {
|
|
1230
|
+
name = name.slice(match[0].length);
|
|
1231
|
+
depth++;
|
|
1232
|
+
}
|
|
1233
|
+
if (!name) continue;
|
|
1234
|
+
const node = name.endsWith("/") ? { type: "folder", name, children: [], depth } : { type: "file", name, depth };
|
|
1235
|
+
let parent;
|
|
1236
|
+
for (let i = depth - 1; i >= 0 && !parent; i--) {
|
|
1237
|
+
parent = stack.get(i);
|
|
1238
|
+
}
|
|
1239
|
+
stack.set(depth, node);
|
|
1240
|
+
if (!parent) continue;
|
|
1241
|
+
if (parent.type === "file") {
|
|
1242
|
+
Object.assign(parent, {
|
|
1243
|
+
type: "folder",
|
|
1244
|
+
children: []
|
|
1245
|
+
});
|
|
1246
|
+
}
|
|
1247
|
+
parent.children.push(node);
|
|
1248
|
+
}
|
|
1249
|
+
return stack.get(0);
|
|
1250
|
+
}
|
|
1251
|
+
function defaultToMDX(node, depth = 0) {
|
|
1252
|
+
if (depth === 0) {
|
|
1253
|
+
return {
|
|
1254
|
+
type: "mdxJsxFlowElement",
|
|
1255
|
+
name: "Files",
|
|
1256
|
+
attributes: [],
|
|
1257
|
+
children: [defaultToMDX(node, depth + 1)]
|
|
1258
|
+
};
|
|
1259
|
+
}
|
|
1260
|
+
const attributes = [
|
|
1261
|
+
{ type: "mdxJsxAttribute", name: "name", value: node.name }
|
|
1262
|
+
];
|
|
1263
|
+
if (node.type === "file") {
|
|
1264
|
+
return {
|
|
1265
|
+
type: "mdxJsxFlowElement",
|
|
1266
|
+
attributes,
|
|
1267
|
+
children: [],
|
|
1268
|
+
name: "File"
|
|
1269
|
+
};
|
|
1270
|
+
}
|
|
1271
|
+
attributes.push({
|
|
1272
|
+
type: "mdxJsxAttribute",
|
|
1273
|
+
name: "defaultOpen",
|
|
1274
|
+
value: null
|
|
1275
|
+
});
|
|
1276
|
+
return {
|
|
1277
|
+
type: "mdxJsxFlowElement",
|
|
1278
|
+
attributes,
|
|
1279
|
+
name: "Folder",
|
|
1280
|
+
children: node.children.map((item) => defaultToMDX(item, depth + 1))
|
|
1281
|
+
};
|
|
1282
|
+
}
|
|
1283
|
+
function remarkMdxFiles(options = {}) {
|
|
1284
|
+
const { lang = "files", toMdx = defaultToMDX } = options;
|
|
1285
|
+
return (tree) => {
|
|
1286
|
+
visit8(tree, "code", (node) => {
|
|
1287
|
+
if (node.lang !== lang || !node.value) return;
|
|
1288
|
+
const fileTree = parseFileTree(node.value);
|
|
1289
|
+
if (!fileTree) return;
|
|
1290
|
+
Object.assign(node, toMdx(fileTree));
|
|
1291
|
+
});
|
|
1292
|
+
};
|
|
1293
|
+
}
|
|
1294
|
+
|
|
1295
|
+
// src/mdx-plugins/remark-mdx-mermaid.ts
|
|
1296
|
+
import { visit as visit9 } from "unist-util-visit";
|
|
1297
|
+
function toMDX(code) {
|
|
1298
|
+
return {
|
|
1299
|
+
type: "mdxJsxFlowElement",
|
|
1300
|
+
name: "Mermaid",
|
|
1301
|
+
attributes: [
|
|
1302
|
+
{
|
|
1303
|
+
type: "mdxJsxAttribute",
|
|
1304
|
+
name: "chart",
|
|
1305
|
+
value: code.trim()
|
|
1306
|
+
}
|
|
1307
|
+
],
|
|
1308
|
+
children: []
|
|
1309
|
+
};
|
|
1310
|
+
}
|
|
1311
|
+
function remarkMdxMermaid(options = {}) {
|
|
1312
|
+
const { lang = "mermaid" } = options;
|
|
1313
|
+
return (tree) => {
|
|
1314
|
+
visit9(tree, "code", (node) => {
|
|
1315
|
+
if (node.lang !== lang || !node.value) return;
|
|
1316
|
+
Object.assign(node, toMDX(node.value));
|
|
1317
|
+
});
|
|
1318
|
+
};
|
|
1319
|
+
}
|
|
1219
1320
|
export {
|
|
1220
1321
|
generateCodeBlockTabs,
|
|
1221
1322
|
parseCodeBlockAttributes,
|
|
@@ -1227,6 +1328,8 @@ export {
|
|
|
1227
1328
|
default2 as remarkGfm,
|
|
1228
1329
|
remarkHeading,
|
|
1229
1330
|
remarkImage,
|
|
1331
|
+
remarkMdxFiles,
|
|
1332
|
+
remarkMdxMermaid,
|
|
1230
1333
|
remarkNpm,
|
|
1231
1334
|
remarkSteps,
|
|
1232
1335
|
remarkStructure,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fumadocs-core",
|
|
3
|
-
"version": "15.7.
|
|
3
|
+
"version": "15.7.7",
|
|
4
4
|
"description": "The library for building a documentation website in Next.js",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"NextJs",
|
|
@@ -91,7 +91,7 @@
|
|
|
91
91
|
],
|
|
92
92
|
"dependencies": {
|
|
93
93
|
"@formatjs/intl-localematcher": "^0.6.1",
|
|
94
|
-
"@orama/orama": "^3.1.
|
|
94
|
+
"@orama/orama": "^3.1.12",
|
|
95
95
|
"@shikijs/rehype": "^3.12.0",
|
|
96
96
|
"@shikijs/transformers": "^3.12.0",
|
|
97
97
|
"github-slugger": "^2.0.0",
|
|
@@ -109,23 +109,23 @@
|
|
|
109
109
|
"unist-util-visit": "^5.0.0"
|
|
110
110
|
},
|
|
111
111
|
"devDependencies": {
|
|
112
|
-
"@mdx-js/mdx": "^3.1.
|
|
112
|
+
"@mdx-js/mdx": "^3.1.1",
|
|
113
113
|
"@mixedbread/sdk": "^0.26.0",
|
|
114
114
|
"@oramacloud/client": "^2.1.4",
|
|
115
|
-
"@tanstack/react-router": "^1.131.
|
|
115
|
+
"@tanstack/react-router": "^1.131.30",
|
|
116
116
|
"@types/estree-jsx": "^1.0.5",
|
|
117
117
|
"@types/hast": "^3.0.4",
|
|
118
118
|
"@types/mdast": "^4.0.3",
|
|
119
119
|
"@types/negotiator": "^0.6.4",
|
|
120
120
|
"@types/node": "24.3.0",
|
|
121
121
|
"@types/react": "^19.1.12",
|
|
122
|
-
"@types/react-dom": "^19.1.
|
|
122
|
+
"@types/react-dom": "^19.1.9",
|
|
123
123
|
"algoliasearch": "5.36.0",
|
|
124
124
|
"mdast-util-mdx-jsx": "^3.2.0",
|
|
125
125
|
"mdast-util-mdxjs-esm": "^2.0.1",
|
|
126
126
|
"next": "^15.5.2",
|
|
127
127
|
"react-router": "^7.8.2",
|
|
128
|
-
"remark-mdx": "^3.1.
|
|
128
|
+
"remark-mdx": "^3.1.1",
|
|
129
129
|
"remove-markdown": "^0.6.2",
|
|
130
130
|
"typescript": "^5.9.2",
|
|
131
131
|
"unified": "^11.0.5",
|