Next.jsReact文档

fuma-tui — Next.js 文档模板

作者 Lee-Si-Yoon

基于 Fumadocs 与 Next.js 的文档模板，把 Obsidian 仓库转成终端风格站点，并提供面向 AI 代理的 llms 端点。

打开源站下载源码 ZIP

看看你的网站会是什么样

浏览真实页面截图，比较内容排版与手机效果。点击下方缩略图切换，放大查看整页细节。

1 个预览视图

桌面端首页

访问演示网站在新标签页打开

桌面端截图首屏预览

由服务器浏览器实际访问页面后截取。

目前有 1 张原始预览，可打开完整图片查看设计细节。

截图用于了解视觉与布局，交互效果请以实际项目为准。

采集于 2026-10-03查看来源

值得关注的模板亮点

从已有项目资料中，快速了解它的特点。

把 Obsidian vault 放入 public/vault/ 即可生成文档站点

终端/TUI 视觉风格：VT323 字体、CRT 扫描线、零圆角、Utopia 流体缩放

基于 d3-force 与 minimap 的 wikilink 关系图

提供 llms.txt、llms-full.txt、llms.mdx 端点供 AI 代理读取

site.config.ts 单文件控制站点名称、强调色、logo、favicon 与 OG 品牌文字

内置 Biome、rumdl、Vale、自定义 linter 与 git pre-commit 钩子

模板详细介绍

fuma-tui 是一个文档类网站模板，面向已有 Obsidian 笔记库的用户。它构建在 Fumadocs 与 Next.js 之上，把 Obsidian vault 放到 public/vault/ 目录后即可生成文档站点，并可直接部署到 Vercel。

视觉上采用终端/TUI 风格：使用 VT323 字体、CRT 扫描线效果、零圆角边框和 Utopia 流体缩放。模板提供基于 d3-force 模拟与 minimap 的 wikilink 关系图，用于浏览笔记之间的链接结构。

面向 AI 的部分体现在 llms.txt、llms-full.txt 和 llms.mdx 端点，便于 AI 代理读取站点内容。项目还包含 Biome、rumdl、Vale、自定义 linter 和 git pre-commit 钩子等团队协作配置，每个组件配有 SPEC.md 规格文件。

品牌定制集中在根目录的 site.config.ts，可设置站点名称、描述、GitHub 仓库链接、强调色、logo、favicon 和 OG 品牌文字，强调色会派生到各主题元素。模板声明无需环境变量即可部署，并内置 ZBSearch 全文搜索。

使用前需注意：仓库采用 MIT 许可，但演示图片、字体、图标等第三方素材需单独核对许可；域名、托管等外部服务可能另行收费。模板本身不承诺生产就绪程度，具体能力以仓库文档与规格文件为准。

Next.js文档

适合你的项目吗？

适用场景

把个人 Obsidian 笔记库发布为可公开访问的文档站点
为团队内部知识库搭建终端风格的浏览界面
需要让 AI 代理通过 llms 端点读取文档内容的场景
希望用 wikilink 关系图展示笔记之间链接结构的项目

适合人群

已有 Obsidian vault 并希望快速上线文档站点的用户
偏好终端/TUI 视觉风格而非常规文档主题的开发者
需要在 Vercel 上以零环境变量方式部署文档站点的团队
关注 AI 代理可读性、需要 llms 端点的项目维护者

上手与定制指南

结合仓库当前版本的说明，按下面的资料检查内容、配置与运行要求。

1
安装依赖并运行初始化脚本：pnpm install、bash scripts/setup.sh、pnpm dev
2
把 Obsidian vault 内容放入 public/vault/ 目录
3
在根目录 site.config.ts 中修改站点名称、描述、仓库链接、强调色、logo 与 OG 品牌文字
4
完整配置说明见 TEMPLATE_SETUP.md，写作规范见 CONTRIBUTING.md，各组件规格见 specs/ 目录
5
演示图片、字体、图标等第三方素材需按各自许可单独核对，不能仅凭代码的 MIT 许可判断

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

本次收录的是公开仓库中采用 MIT 许可的免费版本；免费范围为该版本代码，不代表外部服务或第三方素材免费。

使用时需要遵守

允许免费使用、修改、商用和分发该版本代码。
分发代码副本或实质性部分时，保留原作者版权声明和完整 MIT 许可声明。
代码按现状提供；担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

使用前提是已有 Obsidian 笔记库：需将 vault 内容放入 public/vault/ 目录，模板本身不提供内容，仅负责把该目录渲染为文档站点。
模板依赖 Fumadocs 与 Next.js 两个上游框架，使用与升级需遵循其各自许可与版本要求，不属于本仓库 MIT 授权范围。
部署路径指向 Vercel 一键克隆，实际托管依赖 Vercel 外部服务，可能产生账号注册与费用，需自行评估。
README 声明无需环境变量即可部署，但该说法仅针对 Vercel 部署流程；若改用其他托管或接入外部服务，仍可能需要自行配置密钥与账号。
团队协作能力依赖 Biome、rumdl、Vale 等外部工具链，需在本地或 CI 中自行安装配置，模板不代为提供这些工具。
规格文件是开发约定，不构成功能或质量保证；README 未声明生产就绪，实际可用性需自行验证。
演示图片、字体、图标及其他第三方素材需按各自许可核对，不能仅凭代码的 MIT 许可判断。
域名、托管、数据库、支付或 AI 等外部服务可能另外收费。

查看原文依据

Permission is hereby granted, free of charge
许可证原文

Drop your Obsidian vault into `public/vault/` → ship to Vercel.
README 原文

Built on [Fumadocs](https://fumadocs.dev) + Next.js.
README 原文

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FLee-Si-Yoon%2Ffuma-tui)
README 原文

- ⚡ **Zero env vars** — deploy to Vercel as-is
README 原文

- ✅ **Team-ready** — Biome, rumdl, Vale, custom linters, git pre-commit hooks
README 原文

- 📋 **Spec-driven** — every component has a `SPEC.md`; AI agents develop against specs, not assumptions
README 原文

https://github.com/Lee-Si-Yoon/fuma-tui/blob/main/LICENSE https://github.com/Lee-Si-Yoon/fuma-tui/blob/main/README.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-10-03。结果仅覆盖已读取资料，依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台: GitHub
资料与维护参考分: 资料较完整 · 87 / 100
技术栈: Next.js · React
网站类型: 文档

这个分数如何计算

本站按许可资料（最高30分）、演示链接（12分）、预览图（10分）、Star数（15分）、记录的维护时间（15分）、描述完整度（8分）、功能记录（5分）和分类资料（5分）计算。它不是代码、安全或性能测试，也不是 Google 评分；有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间: 2026-08-21
截图检查日期: 2026-10-03

已收录演示链接。请用你的内容与屏幕尺寸检查；有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 Next.js。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料，不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

审核声明: [email protected] · 2026-10-04

查看当时使用的来源资料

SHA-256: cf6a7920b1d83dfa50349b26effa5e79fa6bcb20877667f2f906f000163a8566

2026-10-03T17:01:47.697Z

来源文件 / 仓库

<a target="_blank" rel="noopener noreferrer" href="https://github.com/Lee-Si-Yoon/fuma-tui/blob/main/public/fuma-tui-social-dark.png">
  <img src="https://github.com/Lee-Si-Yoon/fuma-tui/raw/main/public/fuma-tui-social-dark.png" alt="fuma-tui banner" style="max-width: 100%;">
</a>

> The TUI-styled documentation template for your Obsidian vault.

Built on [Fumadocs](https://fumadocs.dev) + Next.js. Styled like a terminal. Read by AI agents.

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FLee-Si-Yoon%2Ffuma-tui)

## What you get

Drop your Obsidian vault into `public/vault/` → ship to Vercel.

- 🔗 **Wikilink graph** — d3-force simulation + minimap
- 🤖 **AI-friendly** — `llms.txt` / `llms-full.txt` / `llms.mdx` endpoints
- 🖥️ **Terminal aesthetic** — VT323, CRT scanlines, zero border-radius, Utopia fluid scale
- ✅ **Team-ready** — Biome, rumdl, Vale, custom linters, git pre-commit hooks
- 🎨 **One-config rebrand** — `site.config.ts` → accent, logos, OG, scrollbars auto-derived
- ⚡ **Zero env vars** — deploy to Vercel as-is
- 📋 **Spec-driven** — every component has a `SPEC.md`; AI agents develop against specs, not assumptions

## Quickstart

```bash
pnpm install
bash scripts/setup.sh
pnpm dev
```

## Rebranding

Edit `site.config.ts` at the repo root. One file controls everything:

- Site name, description, GitHub repo link
- Accent color → every themed element derived automatically
- Logos, favicon, OG brand text

See [TEMPLATE_SETUP.md](TEMPLATE_SETUP.md) for the full guide. For writing entries, see [CONTRIBUTING.md](CONTRIBUTING.md).

## Specs

Root: [SPEC.md](SPEC.md) — master spec (stack, layout, scripts, frontmatter, constraints).

Per-component specs in `specs/`:

- [CONTENT](specs/CONTENT/SPEC.md) — Obsidian vault, source configuration, math rendering
- [STYLING](specs/STYLING/SPEC.md) — Terminal/TUI theme
- [GRAPH](specs/GRAPH/SPEC.md) — Interactive wikilink graph + minimap
- [DEPLOYMENT](specs/DEPLOYMENT/SPEC.md) — Vercel, dependencies, LLM endpoints
- [SEARCH](specs/SEARCH/SPEC.md) — ZBSearch full-text search (no env vars required)
- [OG](specs/OG/SPEC.md) — OG image generation (next/og, dark TUI style)
- [SKILLS](specs/SKILLS/SPEC.md) — Agent skills registry

---

<a target="_blank" rel="noopener noreferrer" href="https://github.com/fuma-nama/fumadocs">
  <img src="https://github.com/fuma-nama/fumadocs/raw/dev/documents/logo.png" alt="Fumadocs sticker" style="max-width: 100%;">
</a>

反馈内容错误