欢迎
我的文档网站首页
欢迎来到 docs.nabin.cn
这是一个基于 Fumadocs 构建的现代化文档网站,支持 Markdown 和 MDX 格式。
快速开始
安装依赖
首先,确保您的系统已安装 Node.js 18+ 版本:
npm install
npm run dev
项目结构
我们的项目采用以下目录结构:
docs.nabin.cn/
├── content/docs/ # 文档内容
├── src/app/ # Next.js 应用
└── public/ # 静态资源
主要特性
🚀 现代化技术栈
- Next.js 15 - React 全栈框架
- Fumadocs - 专业文档框架
- TypeScript - 类型安全
- Tailwind CSS - 现代化样式
📝 内容管理
- MDX 支持 - 混合 Markdown 和 React 组件
- 自动导航 - 基于文件结构生成侧边栏
- 搜索功能 - 全文搜索支持
- 主题切换 - 明暗主题切换
🎨 界面设计
- 响应式布局 - 适配各种设备
- 优雅的排版 - 专业的文档样式
- 组件丰富 - 内置多种 UI 组件
使用指南
编写文档
在 content/docs/
目录下创建 .mdx
文件:
---
title: 页面标题
description: 页面描述
---
# 一级标题
## 二级标题
### 三级标题
这里是正文内容。
添加组件
您可以在文档中使用各种组件:
高级功能
代码高亮
支持多种编程语言的语法高亮:
interface User {
id: number;
name: string;
email: string;
}
const user: User = {
id: 1,
name: "张三",
email: "zhangsan@example.com"
};
表格
功能 | 状态 | 描述 |
---|---|---|
静态导出 | ✅ | 支持生成静态文件 |
搜索 | ✅ | 全文搜索功能 |
主题 | ✅ | 明暗主题切换 |
多语言 | 🚧 | 开发中 |
引用和提示
提示: 这是一个重要的提示信息,用于突出显示关键内容。
注意: 请注意这个注意事项,避免常见错误。
部署说明
构建项目
npm run build
部署到服务器
- 上传
out/
目录到服务器 - 配置 Nginx 反向代理
- 重启服务
联系我们
如果您有任何问题或建议,欢迎通过以下方式联系:
- GitHub: xiaolinbaba
- 邮箱: your-email@example.com
感谢您使用 docs.nabin.cn!