Source
Setup sources for Loader API
Overview
Content loader accepts different content sources based on a source interface.
Multiple Sources
Pass a record of source objects instead
import { loader } from 'fumadocs-core/source';
import { openapiPlugin, openapiSource } from 'fumadocs-openapi/server';
import { blog, docs } from 'collections/server';
import { lucideIconsPlugin } from 'fumadocs-core/source/lucide-icons';
export const source = loader(
{
docs: docs.toFumadocsSource(),
openapi: blog.toFumadocsSource(),
},
{
baseUrl: '/docs',
},
);To access properties exclusive to each source:
const page = source.getPage(['...']);
if (page.type === 'docs') {
console.log(page.data);
} else {
console.log(page.data);
}Static Source
To plug your own content source, create a StaticSource object.
Since Loader API doesn't rely on file system, file paths only allow virtual paths like file.mdx and content/file.mdx, ./file.mdx and D://content/file.mdx are not allowed.
import type { } from 'fumadocs-core/source';
export function (): <{
: { : string; : string[] }; // Your custom type
: { : string; ?: string }; // Your custom type
}> {
return {
: [
{
: 'page',
: 'folder/index.mdx',
: {
: 'Hello World',
// ...
},
},
{
: 'meta',
: 'meta.json',
: {
: 'Docs',
: ['folder'],
// ...
},
},
],
};
}Dynamic Source
For content sources with revalidation, return a DynamicSource instead:
import type { DynamicSource } from 'fumadocs-core/source';
export function createMySource(): DynamicSource<{
metaData: { title: string; pages: string[] };
pageData: { title: string; description?: string };
}> {
return {
async files() {
return [
{
type: 'page',
path: 'folder/index.mdx',
data: {
title: 'Hello World',
},
},
{
type: 'meta',
path: 'meta.json',
data: {
title: 'Docs',
pages: ['folder'],
},
},
];
},
configure(loader) {
// you can revalidate the loader from source, e.g.
onMyEvent(() => {
loader.revalidate();
});
},
};
}Dynamic sources can only be consumed by dynamicLoader().
How is this guide?
Last updated on