SoarStarter TanStack
Introduction

快速开始

了解基于 TanStack Start 和 fumadocs 构建的文档系统。

文档系统概述

本项目的文档系统建立在 TanStack Startfumadocs 之上。TanStack Start 负责路由与 SSR,fumadocs 负责 MDX 内容模型与文档 UI。

fumadocs

fumadocs 让基于 MDX 的文档写作、页面树生成和文档界面搭建都变得很直接。

核心特性

  • MDX 优先:使用 MDX 编写内容,完整支持 React 组件
  • 基于文件:将内容作为项目中的简单文件进行组织
  • 类型安全:从内容自动生成 TypeScript 类型
  • 全文搜索:开箱即用的全文搜索能力
  • 代码高亮:内置代码块语法高亮

为什么选择 fumadocs?

fumadocs 无需单独的 CMS 或数据库。文档与代码并存,便于版本管理、审查和维护。基于文件的方式意味着你可以使用自己喜欢的编辑器和 Git 工作流。

开始使用

安装依赖

pnpm add fumadocs-core fumadocs-ui fumadocs-mdx

创建内容

content/docs/ 目录下创建 MDX 文件:

---
title: 我的页面
description: 一个文档页面
---

# 我的页面

在这里使用 MDX 语法编写内容。

配置导航

使用 meta.json 文件控制侧边栏导航:

{
  "title": "章节标题",
  "pages": ["page-one", "page-two"]
}

连接文档数据源

在这个 starter 中,文档系统通过 source.config.tssrc/lib/source.tssrc/routes/{-$locale}/_docs/docs/$.tsx 这条 catch-all 路由接入应用。

谁在使用

On this page