本機 Markdown

簡介

@fumadocs/local-md 是用於本機 Markdown/MDX 檔案的內容來源。它在設計上採用免打包 (bundleless) 架構，因此能完全在執行階段運作。

與 MDX Remote 相比，它專注於本機檔案，並負責處理流程中更多的環節 (frontmatter、meta 檔案、搜尋索引) 。

與 Fumadocs MDX 相比，它不需要型別產生或打包工具即可運作，但無法使用建置階段的圖片最佳化。

限制

不支援建置階段的圖片最佳化。
MDX 檔案中不支援匯入／匯出，但您可以在算繪時傳入元件。

設定

安裝套件：

npm install @fumadocs/local-md shiki

之所以要安裝 shiki，是因為打包工具必須將它外部化 (externalize) 。

建立 localMd 實例，並將其連接至 Fumadocs：

lib/source.ts

import { dynamicLoader } from 'fumadocs-core/source';
import { localMd } from '@fumadocs/local-md';

const docs = localMd({
  dir: 'content/docs',
  // 選項
});

const docsLoader = dynamicLoader(docs.dynamicSource(), {
  baseUrl: '/docs',
});

export async function getSource() {
  return docsLoader.get();
}

Schema

您可以傳入 frontmatterSchema 與 metaSchema，以自訂驗證用的 schema：

lib/source.ts

import { localMd } from '@fumadocs/local-md';
import { pageSchema, metaSchema } from 'fumadocs-core/source/schema';

const docs = localMd({
  dir: 'content/docs',
  frontmatterSchema: pageSchema.extend({
    // ...
  }),
  metaSchema: metaSchema.extend({
    // ...
  }),
});

使用方式

getSource() 會回傳一般的內容載入器。每個頁面都有 page.data.load()，它會編譯該頁面並回傳一個算繪器 (renderer) 。

在您的頁面中算繪：

import type { ReactNode } from 'react';
import { DocsLayout } from 'fumadocs-ui/layouts/docs';
import { getSource } from '@/lib/source';

export default async function Layout({ children }: { children: ReactNode }) {
  const source = await getSource();

  return <DocsLayout tree={source.getPageTree()}>{children}</DocsLayout>;
}

引入

<include> 預設為啟用狀態：

content/docs/page.mdx

<include>../shared/note.md</include>

在 Markdown 檔案中，請先設定好 remark-directive，再使用 ::include[../shared/note.md] 指令：

lib/source.ts

import remarkDirective from 'remark-directive';

const docs = localMd({
  dir: 'content/docs',
  mdOptions: { remarkPlugins: [remarkDirective] },
});

熱重載

@fumadocs/local-md 在執行階段讀取檔案，因此預設不會監看任何檔案。

開發期間，Vite 外掛會透過 Vite 的檔案監看器讓來源失效，不需要額外的處理程序或連接埠。請將外掛加入您的設定，並連接來源：

import { defineConfig } from 'waku/config';
import { localContentPlugin } from '@fumadocs/local-md/dev/vite';

export default defineConfig({
  vite: {
    plugins: [localContentPlugin()],
  },
});

由於內容檔案位於模組圖之外，外掛會將您的內容目錄加入 Vite 的監看器。由於沒有任何模組失效，外掛會改為直接重新載入瀏覽器。若要自行處理重新載入，請傳入 localContentPlugin({ reload: false })。

當 Markdown 或 MDX 檔案 (包括其引入的檔案) 變更時，來源就會重新載入。若要串接自訂的監看器，請監看 docs.dir 以及傳入 docs.onDependency() 的檔案，並在檔案變更時呼叫 docs.invalidateFile(path)。

JavaScript 引擎

MDX 檔案 (*.mdx) 會透過 new Function 執行，因此在禁止使用 eval() 的環境中 (例如 Cloudflare Workers) 無法運作。

Markdown 檔案 (*.md) 會直接從語法樹算繪，不需要 eval()。外掛產生的 JSX 則由內建的虛擬 JavaScript 引擎進行求值，您可以透過 rendererOptions.executor 替換此引擎。

請勿將不受信任的 MDX 檔案放入 dir，因為這些檔案會以 JavaScript 的形式在您的應用程式中執行。

停用重新驗證

staticSource() 會回傳一次性的快照，不會重新驗證。它需搭配 loader() 使用，而非 dynamicLoader()：

lib/source.ts

import { loader } from 'fumadocs-core/source';
import { localMd } from '@fumadocs/local-md';

const docs = localMd({
  dir: 'content/docs',
});

export const source = loader(await docs.staticSource(), {
  baseUrl: '/docs',
});

從 Fumadocs MDX 遷移

若要遷移，請將 Fumadocs MDX 的設定替換為 @fumadocs/local-md 的設定。

遷移前

lib/source.ts

import { loader } from 'fumadocs-core/source';
import { defineDocs } from 'fumadocs-mdx/macro';

const docs = defineDocs({
  dir: 'content/docs',
});

export const source = loader({
  baseUrl: '/docs',
  source: docs.toFumadocsSource(),
});

遷移後

lib/source.ts

import { dynamicLoader } from 'fumadocs-core/source';
import { localMd } from '@fumadocs/local-md';

const docs = localMd({
  dir: 'content/docs',
});

const docsLoader = dynamicLoader(docs.dynamicSource(), {
  baseUrl: '/docs',
});

export async function getSource() {
  return docsLoader.get();
}

接著：

從您的 Vite 設定中移除 fumadocsMdx()。
設定熱重載。

最後，將原本參照 source 物件的地方改為使用 getSource()：

src/pages/docs/_layout.tsx

import type { ReactNode } from 'react';
import { getSource } from '@/lib/source';
import { DocsLayout } from 'fumadocs-ui/layouts/docs';

export default async function Layout({ children }: { children: ReactNode }) {
  return <DocsLayout tree={source.getPageTree()}>{children}</DocsLayout>;

  const docs = await getSource();
  return <DocsLayout tree={docs.getPageTree()}>{children}</DocsLayout>;
}

頁面資料 API 也有所變更：

const page = source.getPage(['...']);

// 標題與描述
page.data.title;

// 自訂 frontmatter 屬性
page.data.full;

// getText() API
await page.data.getText('processed');

// 編譯後的屬性：
page.data.structuredData;
page.data.toc;
return (
  <div>
    <page.data.body components={{}} />
  </div>
);

簡介複製錨點連結

限制複製錨點連結

設定複製錨點連結

Schema複製錨點連結

使用方式複製錨點連結

引入複製錨點連結

熱重載複製錨點連結

JavaScript 引擎複製錨點連結

停用重新驗證複製錨點連結

從 Fumadocs MDX 遷移複製錨點連結

遷移前複製錨點連結

遷移後複製錨點連結

本頁目錄

簡介

限制

設定

Schema

使用方式

引入

熱重載

JavaScript 引擎

停用重新驗證

從 Fumadocs MDX 遷移

遷移前

遷移後