Waku

快速开始

在继续之前，请确保配置：

Tailwind CSS 4。
Fumadocs MDX：按照设置指南操作，并创建诸如 lib/source.ts 等必需文件。

安装

npm i fumadocs-core fumadocs-ui

样式

将以下内容添加到您的 Tailwind CSS 文件中：

src/styles/globals.css

@import 'tailwindcss';
@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';

创建页面

创建一个用于共享布局属性的文件：

src/lib/layout.shared.tsx

import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';

export function baseOptions(): BaseLayoutProps {
  return {
    nav: {
      title: 'Waku',
    },
  };
}

创建以下路由：

import type { ReactNode } from 'react';
import { DocsLayout } from 'fumadocs-ui/layouts/docs';
import { source } from '@/lib/source';
import { baseOptions } from '@/lib/layout.shared';

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

最后，将整个应用包装在 Fumadocs 提供者之下：

'use client';
import type { ReactNode } from 'react';
import { WakuProvider } from 'fumadocs-core/framework/waku';
import { RootProvider } from 'fumadocs-ui/provider/base';

export function Provider({ children }: { children: ReactNode }) {
  return (
    <WakuProvider>
      <RootProvider>{children}</RootProvider>
    </WakuProvider>
  );
}

完成

您可以在 content/docs 下开始编写文档：

content/docs/index.mdx

---
title: Hello World
---

I love Fumadocs

快速开始

安装

样式

创建页面

完成

On this page