diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 361f27b28..a1465c36b 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -22,10 +22,13 @@ jobs:
- uses: actions/setup-node@v4
with:
node-version: 22
- - run: cd docs && npm ci && npm run build
+ - uses: pnpm/action-setup@v4
+ with:
+ version: 10
+ - run: cd docs && pnpm install --frozen-lockfile && pnpm build
- uses: actions/upload-pages-artifact@v3
with:
- path: docs/.vitepress/dist
+ path: docs/out
deploy:
needs: build
diff --git a/.gitignore b/.gitignore
index ea195c5d3..caa5426c8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,6 +6,9 @@ node_modules/
# Build output
dist/
/target/
+docs/.next/
+docs/out/
+docs/.source/
# OS files
.DS_Store
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
deleted file mode 100644
index ba9b46daf..000000000
--- a/docs/.vitepress/config.ts
+++ /dev/null
@@ -1,160 +0,0 @@
-import { defineConfig } from 'vitepress'
-
-export default defineConfig({
- title: 'DBX',
- description: '25+ databases in 15 MB. Desktop & Docker self-hosting, with built-in AI assistant.',
- base: '/dbx/',
- head: [
- ['link', { rel: 'icon', href: '/dbx/logo.png' }],
- ],
- locales: {
- root: {
- label: 'English',
- lang: 'en',
- themeConfig: {
- nav: [
- { text: 'Guide', link: '/guide/what-is-dbx' },
- {
- text: 'Features',
- items: [
- { text: 'Database Support', link: '/guide/databases' },
- { text: 'Query Editor', link: '/guide/query-editor' },
- { text: 'Data Grid', link: '/guide/data-grid' },
- { text: 'Schema Diff', link: '/guide/schema-diff' },
- { text: 'Data Transfer', link: '/guide/data-transfer' },
- { text: 'AI Assistant', link: '/guide/ai-assistant' },
- { text: 'MCP Integration', link: '/guide/mcp' },
- ],
- },
- { text: 'Changelog', link: 'https://github.com/t8y2/dbx/releases' },
- { text: 'Download', link: 'https://github.com/t8y2/dbx/releases' },
- ],
- sidebar: [
- {
- text: 'Introduction',
- items: [
- { text: 'What is DBX?', link: '/guide/what-is-dbx' },
- { text: 'Getting Started', link: '/guide/getting-started' },
- { text: 'Database Support', link: '/guide/databases' },
- ],
- },
- {
- text: 'Core Features',
- items: [
- { text: 'Query Editor', link: '/guide/query-editor' },
- { text: 'Data Grid', link: '/guide/data-grid' },
- { text: 'Schema Browser', link: '/guide/schema-browser' },
- ],
- },
- {
- text: 'Advanced Features',
- items: [
- { text: 'Schema Diff', link: '/guide/schema-diff' },
- { text: 'Data Transfer', link: '/guide/data-transfer' },
- { text: 'Table Structure Editor', link: '/guide/table-structure' },
- { text: 'Field Lineage', link: '/guide/field-lineage' },
- { text: 'Table Import', link: '/guide/table-import' },
- { text: 'SQL File Execution', link: '/guide/sql-file' },
- { text: 'Database Export', link: '/guide/database-export' },
- ],
- },
- {
- text: 'AI & Automation',
- items: [
- { text: 'AI Assistant', link: '/guide/ai-assistant' },
- { text: 'MCP Integration', link: '/guide/mcp' },
- ],
- },
- {
- text: 'Settings',
- items: [
- { text: 'Config Export/Import', link: '/guide/config-export' },
- { text: 'SSH Tunnel', link: '/guide/ssh-tunnel' },
- ],
- },
- ],
- },
- },
- 'zh-CN': {
- label: '简体中文',
- lang: 'zh-CN',
- themeConfig: {
- nav: [
- { text: '指南', link: '/zh-CN/guide/what-is-dbx' },
- {
- text: '功能',
- items: [
- { text: '数据库支持', link: '/zh-CN/guide/databases' },
- { text: '查询编辑器', link: '/zh-CN/guide/query-editor' },
- { text: '数据表格', link: '/zh-CN/guide/data-grid' },
- { text: 'Schema 对比', link: '/zh-CN/guide/schema-diff' },
- { text: '数据传输', link: '/zh-CN/guide/data-transfer' },
- { text: 'AI 助手', link: '/zh-CN/guide/ai-assistant' },
- { text: 'MCP 集成', link: '/zh-CN/guide/mcp' },
- ],
- },
- { text: '更新日志', link: 'https://github.com/t8y2/dbx/releases' },
- { text: '下载', link: 'https://github.com/t8y2/dbx/releases' },
- ],
- sidebar: [
- {
- text: '介绍',
- items: [
- { text: '什么是 DBX？', link: '/zh-CN/guide/what-is-dbx' },
- { text: '快速开始', link: '/zh-CN/guide/getting-started' },
- { text: '数据库支持', link: '/zh-CN/guide/databases' },
- ],
- },
- {
- text: '核心功能',
- items: [
- { text: '查询编辑器', link: '/zh-CN/guide/query-editor' },
- { text: '数据表格', link: '/zh-CN/guide/data-grid' },
- { text: '结构浏览', link: '/zh-CN/guide/schema-browser' },
- ],
- },
- {
- text: '高级功能',
- items: [
- { text: 'Schema 对比', link: '/zh-CN/guide/schema-diff' },
- { text: '数据传输', link: '/zh-CN/guide/data-transfer' },
- { text: '表结构编辑器', link: '/zh-CN/guide/table-structure' },
- { text: '字段血缘', link: '/zh-CN/guide/field-lineage' },
- { text: '表数据导入', link: '/zh-CN/guide/table-import' },
- { text: 'SQL 文件执行', link: '/zh-CN/guide/sql-file' },
- { text: '数据库导出', link: '/zh-CN/guide/database-export' },
- ],
- },
- {
- text: 'AI 与自动化',
- items: [
- { text: 'AI 助手', link: '/zh-CN/guide/ai-assistant' },
- { text: 'MCP 集成', link: '/zh-CN/guide/mcp' },
- ],
- },
- {
- text: '设置',
- items: [
- { text: '配置导出/导入', link: '/zh-CN/guide/config-export' },
- { text: 'SSH 隧道', link: '/zh-CN/guide/ssh-tunnel' },
- ],
- },
- ],
- },
- },
- },
- themeConfig: {
- logo: '/logo.png',
- socialLinks: [
- { icon: 'github', link: 'https://github.com/t8y2/dbx' },
- { icon: 'npm', link: 'https://www.npmjs.com/package/@dbx-app/mcp-server' },
- ],
- footer: {
- message: 'Released under the AGPL-3.0 License.',
- copyright: 'Copyright © 2024-present DBX Contributors',
- },
- search: {
- provider: 'local',
- },
- },
-})
diff --git a/docs/app/[lang]/docs/[[...slug]]/page.tsx b/docs/app/[lang]/docs/[[...slug]]/page.tsx
new file mode 100644
index 000000000..d269af72c
--- /dev/null
+++ b/docs/app/[lang]/docs/[[...slug]]/page.tsx
@@ -0,0 +1,43 @@
+import { source } from '@/lib/source';
+import { notFound } from 'next/navigation';
+import {
+ DocsPage,
+ DocsBody,
+ DocsTitle,
+ DocsDescription,
+} from 'fumadocs-ui/page';
+import defaultMdxComponents from 'fumadocs-ui/mdx';
+import type { MDXContent } from 'mdx/types';
+import type { TOCItemType } from 'fumadocs-core/toc';
+
+export default async function Page({
+ params,
+}: {
+ params: Promise<{ lang: string; slug?: string[] }>;
+}) {
+ const { lang, slug } = await params;
+ const page = source.getPage(slug, lang);
+ if (!page) notFound();
+
+ const { body: MDX, toc } = page.data as unknown as {
+ body: MDXContent;
+ toc: TOCItemType[];
+ };
+
+ return (
+
+ {page.data.title}
+ {page.data.description}
+
+
+
+
+ );
+}
+
+export function generateStaticParams() {
+ return source.generateParams().map((params) => ({
+ lang: params.lang,
+ slug: params.slug,
+ }));
+}
diff --git a/docs/app/[lang]/docs/layout.tsx b/docs/app/[lang]/docs/layout.tsx
new file mode 100644
index 000000000..8f9f80f42
--- /dev/null
+++ b/docs/app/[lang]/docs/layout.tsx
@@ -0,0 +1,67 @@
+import type { ReactNode } from 'react';
+import { DocsLayout } from 'fumadocs-ui/layouts/docs';
+import { source } from '@/lib/source';
+
+function DiscordIcon() {
+ return (
+
+ );
+}
+
+function QQIcon() {
+ return (
+
+ );
+}
+
+export default async function Layout({
+ params,
+ children,
+}: {
+ params: Promise<{ lang: string }>;
+ children: ReactNode;
+}) {
+ const { lang } = await params;
+
+ return (
+
+ 
+ DBX
+
+ ),
+ }}
+ githubUrl="https://github.com/t8y2/dbx"
+ links={[
+ {
+ type: 'icon',
+ icon: ,
+ text: 'Discord',
+ url: 'https://discord.gg/W7NyVDRt6a',
+ external: true,
+ },
+ {
+ type: 'icon',
+ icon: ,
+ text: 'QQ',
+ url: 'https://qm.qq.com/cgi-bin/qm/qr?k=&group_code=1087880322',
+ external: true,
+ },
+ ]}
+ sidebar={{
+ defaultOpenLevel: 1,
+ }}
+ >
+ {children}
+
+ );
+}
diff --git a/docs/app/[lang]/layout.tsx b/docs/app/[lang]/layout.tsx
new file mode 100644
index 000000000..2a5fa0683
--- /dev/null
+++ b/docs/app/[lang]/layout.tsx
@@ -0,0 +1,27 @@
+import type { ReactNode } from 'react';
+import { RootProvider } from 'fumadocs-ui/provider/next';
+import { i18nUI } from '@/lib/i18n';
+
+export default async function LangLayout({
+ params,
+ children,
+}: {
+ params: Promise<{ lang: string }>;
+ children: ReactNode;
+}) {
+ const { lang } = await params;
+
+ return (
+
+
+
+ {children}
+
+
+
+ );
+}
+
+export function generateStaticParams() {
+ return [{ lang: 'en' }, { lang: 'cn' }];
+}
diff --git a/docs/app/[lang]/page.tsx b/docs/app/[lang]/page.tsx
new file mode 100644
index 000000000..7e6abcdf6
--- /dev/null
+++ b/docs/app/[lang]/page.tsx
@@ -0,0 +1,10 @@
+import { redirect } from 'next/navigation';
+
+export default async function LangPage({
+ params,
+}: {
+ params: Promise<{ lang: string }>;
+}) {
+ const { lang } = await params;
+ redirect(`/${lang}/docs/what-is-dbx`);
+}
diff --git a/docs/app/global.css b/docs/app/global.css
new file mode 100644
index 000000000..6ff46f2e4
--- /dev/null
+++ b/docs/app/global.css
@@ -0,0 +1,3 @@
+@import 'tailwindcss';
+@import 'fumadocs-ui/css/ocean.css';
+@import 'fumadocs-ui/css/preset.css';
diff --git a/docs/app/layout.tsx b/docs/app/layout.tsx
new file mode 100644
index 000000000..79a7f0763
--- /dev/null
+++ b/docs/app/layout.tsx
@@ -0,0 +1,15 @@
+import './global.css';
+import type { ReactNode } from 'react';
+
+export const metadata = {
+ title: {
+ default: 'DBX',
+ template: '%s | DBX',
+ },
+ description: '25+ databases in 15 MB. Desktop & Docker self-hosting, with built-in AI assistant.',
+ icons: { icon: '/dbx/logo.png' },
+};
+
+export default function RootLayout({ children }: { children: ReactNode }) {
+ return children;
+}
diff --git a/docs/app/page.tsx b/docs/app/page.tsx
new file mode 100644
index 000000000..25eacb752
--- /dev/null
+++ b/docs/app/page.tsx
@@ -0,0 +1,5 @@
+import { redirect } from 'next/navigation';
+
+export default function Page() {
+ redirect('/cn');
+}
diff --git a/docs/zh-CN/guide/ai-assistant.md b/docs/content/docs/ai-assistant.cn.mdx
similarity index 56%
rename from docs/zh-CN/guide/ai-assistant.md
rename to docs/content/docs/ai-assistant.cn.mdx
index d30ea296a..62ff54b49 100644
--- a/docs/zh-CN/guide/ai-assistant.md
+++ b/docs/content/docs/ai-assistant.cn.mdx
@@ -1,4 +1,7 @@
-# AI 助手
+---
+title: AI 助手
+description: 内置 AI 助手，帮你编写、解释、优化和修复 SQL 查询。
+---
DBX 内置 AI 助手，帮你编写、解释、优化和修复 SQL 查询。
@@ -6,7 +9,7 @@ DBX 内置 AI 助手，帮你编写、解释、优化和修复 SQL 查询。
1. 点击工具栏的 **设置** 图标
2. 进入 **AI 设置**
-3. 选择供应商（Claude 或 OpenAI）
+3. 选择供应商（Claude、OpenAI 或自定义端点）
4. 输入 API Key
5. 选择模型
@@ -38,8 +41,10 @@ AI 助手会根据你的数据库结构生成 SQL。
|---|---|
| Anthropic (Claude) | Claude 4 Opus、Claude 4 Sonnet、Claude 3.5 Haiku |
| OpenAI | GPT-4o、GPT-4o-mini、o3-mini |
-| 兼容接口 | 任何 OpenAI 兼容的 API 端点 |
+| 自定义端点 | 任何 OpenAI 兼容的 API 端点 |
+
+你可以配置自定义的 OpenAI 兼容端点（自定义端点），连接第三方或自托管的 AI 服务。只需在 AI 设置中选择"自定义端点"，填入 API 地址和 Key 即可。
## 更强大的 AI 体验
-除了内置 AI 助手，还可以试试 [MCP 集成](/zh-CN/guide/mcp)。它让 Claude Code、Cursor 等 AI 编程助手直接查询你的数据库，并在 DBX 中打开结果。
+除了内置 AI 助手，还可以试试 [MCP 集成](/cn/docs/mcp)。它让 Claude Code、Cursor 等 AI 编程助手直接查询你的数据库，并在 DBX 中打开结果。
diff --git a/docs/guide/ai-assistant.md b/docs/content/docs/ai-assistant.mdx
similarity index 62%
rename from docs/guide/ai-assistant.md
rename to docs/content/docs/ai-assistant.mdx
index 37229d82d..96edd10f7 100644
--- a/docs/guide/ai-assistant.md
+++ b/docs/content/docs/ai-assistant.mdx
@@ -1,3 +1,8 @@
+---
+title: AI Assistant
+description: Built-in AI assistant for writing, explaining, optimizing, and fixing SQL queries.
+---
+
# AI Assistant
DBX has a built-in AI assistant that helps you write, explain, optimize, and fix SQL queries.
@@ -6,8 +11,8 @@ DBX has a built-in AI assistant that helps you write, explain, optimize, and fix
1. Click the **Settings** icon in the toolbar
2. Go to **AI Settings**
-3. Choose your provider (Claude or OpenAI)
-4. Enter your API key
+3. Choose your provider (Claude, OpenAI, or a custom OpenAI-compatible endpoint)
+4. Enter your API key (and endpoint URL for custom providers)
5. Select a model
## Features
@@ -38,8 +43,8 @@ When a query fails, click **Fix with AI** to get a corrected version.
|---|---|
| Anthropic (Claude) | Claude 4 Opus, Claude 4 Sonnet, Claude 3.5 Haiku |
| OpenAI | GPT-4o, GPT-4o-mini, o3-mini |
-| Compatible | Any OpenAI-compatible API endpoint |
+| Custom / OpenAI-compatible | Any endpoint that implements the OpenAI chat completions API (e.g., Ollama, LM Studio, Azure OpenAI, self-hosted models) |
## Beyond Built-in AI
-For a more powerful AI-driven database experience, try the [MCP integration](/guide/mcp). It lets AI coding agents like Claude Code and Cursor directly query your databases and open results in DBX.
+For a more powerful AI-driven database experience, try the [MCP integration](/docs/mcp). It lets AI coding agents like Claude Code and Cursor directly query your databases and open results in DBX.
diff --git a/docs/zh-CN/guide/config-export.md b/docs/content/docs/config-export.cn.mdx
similarity index 75%
rename from docs/zh-CN/guide/config-export.md
rename to docs/content/docs/config-export.cn.mdx
index dd0cc9595..ec4e8aced 100644
--- a/docs/zh-CN/guide/config-export.md
+++ b/docs/content/docs/config-export.cn.mdx
@@ -1,17 +1,20 @@
-# 配置导出/导入
+---
+title: 配置导出/导入
+description: 导出数据库连接配置（含加密密码），方便在不同电脑之间迁移。
+---
导出数据库连接配置（含加密密码），方便在不同电脑之间迁移。
## 导出
-1. 点击侧边栏顶部的 **导出** 按钮（↓）
+1. 点击侧边栏顶部的 **导出** 按钮
2. 输入密码短语来加密连接密码
3. 选择保存位置
4. 导出文件包含所有连接及密码，已加密
## 导入
-1. 点击侧边栏顶部的 **导入** 按钮（↑）
+1. 点击侧边栏顶部的 **导入** 按钮
2. 选择导出的文件
3. 如果文件已加密，输入密码短语
4. 连接导入完成，密码自动恢复
diff --git a/docs/guide/config-export.md b/docs/content/docs/config-export.mdx
similarity index 77%
rename from docs/guide/config-export.md
rename to docs/content/docs/config-export.mdx
index b6a4dbfa5..ec89b7229 100644
--- a/docs/guide/config-export.md
+++ b/docs/content/docs/config-export.mdx
@@ -1,17 +1,22 @@
+---
+title: Config Export/Import
+description: Export and import database connections with encrypted passwords to migrate between machines.
+---
+
# Config Export/Import
Export your database connections (with encrypted passwords) to migrate between machines.
## Export
-1. Click the **Export** button (↓) in the sidebar header
+1. Click the **Export** button in the sidebar header
2. Enter a passphrase to encrypt your passwords
3. Choose a save location
4. The exported file contains all connections with passwords, encrypted
## Import
-1. Click the **Import** button (↑) in the sidebar header
+1. Click the **Import** button in the sidebar header
2. Select the exported file
3. If encrypted, enter the passphrase
4. Connections are imported with passwords restored
diff --git a/docs/zh-CN/guide/data-grid.md b/docs/content/docs/data-grid.cn.mdx
similarity index 91%
rename from docs/zh-CN/guide/data-grid.md
rename to docs/content/docs/data-grid.cn.mdx
index 2b2be840b..2b0999e49 100644
--- a/docs/zh-CN/guide/data-grid.md
+++ b/docs/content/docs/data-grid.cn.mdx
@@ -1,4 +1,7 @@
-# 数据表格
+---
+title: 数据表格
+description: 浏览和编辑表中的数据，支持虚拟滚动、行内编辑、排序过滤和多种格式导出。
+---
DBX 的数据表格组件用于浏览和编辑表中的数据，支持大数据量虚拟滚动、行内编辑、排序过滤以及多种格式导出。
diff --git a/docs/guide/data-grid.md b/docs/content/docs/data-grid.mdx
similarity index 94%
rename from docs/guide/data-grid.md
rename to docs/content/docs/data-grid.mdx
index 1f31db25a..17756ce70 100644
--- a/docs/guide/data-grid.md
+++ b/docs/content/docs/data-grid.mdx
@@ -1,3 +1,8 @@
+---
+title: Data Grid
+description: Browse, edit, and export query results in a high-performance spreadsheet-like interface.
+---
+
# Data Grid
The Data Grid displays query results and table data in a high-performance, spreadsheet-like interface. It supports browsing large datasets, inline editing, and exporting data in multiple formats.
diff --git a/docs/zh-CN/guide/data-transfer.md b/docs/content/docs/data-transfer.cn.mdx
similarity index 90%
rename from docs/zh-CN/guide/data-transfer.md
rename to docs/content/docs/data-transfer.cn.mdx
index 43b07d52b..b7e0ec58a 100644
--- a/docs/zh-CN/guide/data-transfer.md
+++ b/docs/content/docs/data-transfer.cn.mdx
@@ -1,4 +1,7 @@
-# 数据传输
+---
+title: 数据传输
+description: 在不同数据库引擎之间传输数据，支持跨引擎迁移。
+---
DBX 支持在不同数据库引擎之间传输数据，例如将 MySQL 中的数据迁移到 PostgreSQL，或从 SQLite 导入数据到 SQL Server。
diff --git a/docs/guide/data-transfer.md b/docs/content/docs/data-transfer.mdx
similarity index 91%
rename from docs/guide/data-transfer.md
rename to docs/content/docs/data-transfer.mdx
index 372f08d24..ba71b28e7 100644
--- a/docs/guide/data-transfer.md
+++ b/docs/content/docs/data-transfer.mdx
@@ -1,3 +1,8 @@
+---
+title: Data Transfer
+description: Move data between database connections, even across different database engines.
+---
+
# Data Transfer
Data Transfer moves data between two database connections, even when they use different database engines. This is useful for migrating data, populating a development environment, or consolidating data from multiple sources.
diff --git a/docs/zh-CN/guide/database-export.md b/docs/content/docs/database-export.cn.mdx
similarity index 88%
rename from docs/zh-CN/guide/database-export.md
rename to docs/content/docs/database-export.cn.mdx
index 18c1776b8..9ff890f2b 100644
--- a/docs/zh-CN/guide/database-export.md
+++ b/docs/content/docs/database-export.cn.mdx
@@ -1,4 +1,7 @@
-# 数据库导出
+---
+title: 数据库导出
+description: 将整个数据库导出为 SQL 文件，包含表结构和数据，适用于备份和迁移。
+---
DBX 支持将整个数据库导出为 SQL 文件，包含表结构（DDL）和数据，适用于数据库备份和迁移。
diff --git a/docs/guide/database-export.md b/docs/content/docs/database-export.mdx
similarity index 88%
rename from docs/guide/database-export.md
rename to docs/content/docs/database-export.mdx
index ba7987572..2cb9e0fc2 100644
--- a/docs/guide/database-export.md
+++ b/docs/content/docs/database-export.mdx
@@ -1,3 +1,8 @@
+---
+title: Database Export
+description: Generate SQL dump files with table definitions and row data.
+---
+
# Database Export
Database Export generates a SQL dump of your database, including table definitions (DDL) and row data. The output is a `.sql` file that can be used to recreate the database or transfer it to another environment.
@@ -35,4 +40,4 @@ Set the row limit to `0` or leave it blank to export all rows.
3. Choose the output file location.
4. Start the export.
-The generated `.sql` file can be executed in DBX using the [SQL File Execution](./sql-file.md) feature, or in any compatible database client.
+The generated `.sql` file can be executed in DBX using the [SQL File Execution](/docs/sql-file) feature, or in any compatible database client.
diff --git a/docs/zh-CN/guide/databases.md b/docs/content/docs/databases.cn.mdx
similarity index 77%
rename from docs/zh-CN/guide/databases.md
rename to docs/content/docs/databases.cn.mdx
index 3b7836419..87226fdc6 100644
--- a/docs/zh-CN/guide/databases.md
+++ b/docs/content/docs/databases.cn.mdx
@@ -1,6 +1,9 @@
-# 数据库支持
+---
+title: 数据库支持
+description: DBX 通过 Rust 原生驱动支持 25+ 种数据库。
+---
-DBX 通过 Rust 原生驱动支持 13+ 种数据库。
+DBX 通过 Rust 原生驱动支持 25+ 种数据库。
## 完整支持
@@ -46,6 +49,4 @@ DBX 通过 Rust 原生驱动支持 13+ 种数据库。
| CockroachDB | 26257 | |
| DM（达梦） | 5236 | 需开启 PG 兼容模式 |
-::: tip 达梦数据库说明
-达梦数据库需要开启 PG 兼容模式。在 `dm.ini` 中设置 `COMPATIBLE_MODE=7` 并重启服务。
-:::
+**达梦数据库说明：** 达梦数据库需要开启 PG 兼容模式。在 `dm.ini` 中设置 `COMPATIBLE_MODE=7` 并重启服务。
diff --git a/docs/guide/databases.md b/docs/content/docs/databases.mdx
similarity index 76%
rename from docs/guide/databases.md
rename to docs/content/docs/databases.mdx
index 2fbedd302..dd119a99d 100644
--- a/docs/guide/databases.md
+++ b/docs/content/docs/databases.mdx
@@ -1,6 +1,11 @@
+---
+title: Database Support
+description: DBX supports 25+ database engines through native Rust drivers.
+---
+
# Database Support
-DBX supports 13+ database engines through native Rust drivers.
+DBX supports 25+ database engines through native Rust drivers.
## Fully Supported
@@ -46,6 +51,5 @@ These databases use PostgreSQL protocol and work with the PostgreSQL driver:
| CockroachDB | 26257 | |
| DM (Dameng) | 5236 | Requires PG compatibility mode |
-::: tip DM (Dameng) Note
-DM database requires PG compatibility mode to be enabled. Set `COMPATIBLE_MODE=7` in `dm.ini` and restart the service.
-:::
+> **DM (Dameng) Note:**
+> DM database requires PG compatibility mode to be enabled. Set `COMPATIBLE_MODE=7` in `dm.ini` and restart the service.
diff --git a/docs/zh-CN/guide/field-lineage.md b/docs/content/docs/field-lineage.cn.mdx
similarity index 92%
rename from docs/zh-CN/guide/field-lineage.md
rename to docs/content/docs/field-lineage.cn.mdx
index c89a87096..4b14410f2 100644
--- a/docs/zh-CN/guide/field-lineage.md
+++ b/docs/content/docs/field-lineage.cn.mdx
@@ -1,4 +1,7 @@
-# 字段血缘
+---
+title: 字段血缘
+description: 理解数据库中字段之间的关联关系，追踪数据的来源和去向。
+---
字段血缘功能帮助你理解数据库中字段之间的关联关系，追踪数据的来源和去向。DBX 会从多个维度自动分析字段之间的关联，并标注置信度。
diff --git a/docs/guide/field-lineage.md b/docs/content/docs/field-lineage.mdx
similarity index 94%
rename from docs/guide/field-lineage.md
rename to docs/content/docs/field-lineage.mdx
index 48ea18c93..af5e49ee8 100644
--- a/docs/guide/field-lineage.md
+++ b/docs/content/docs/field-lineage.mdx
@@ -1,3 +1,8 @@
+---
+title: Field Lineage
+description: Trace column relationships across foreign keys, views, and query history.
+---
+
# Field Lineage
Field Lineage helps you understand how columns in your database relate to each other. It traces relationships across foreign keys, views, and query history to give you a complete picture of where data comes from and where it flows.
diff --git a/docs/zh-CN/guide/getting-started.md b/docs/content/docs/getting-started.cn.mdx
similarity index 73%
rename from docs/zh-CN/guide/getting-started.md
rename to docs/content/docs/getting-started.cn.mdx
index 1819c6212..8031038fe 100644
--- a/docs/zh-CN/guide/getting-started.md
+++ b/docs/content/docs/getting-started.cn.mdx
@@ -1,4 +1,7 @@
-# 快速开始
+---
+title: 快速开始
+description: 安装 DBX 并创建你的第一个数据库连接。
+---
## 安装
@@ -27,15 +30,18 @@ scoop install dbx
scoop update dbx
```
-### macOS 说明
+### Docker 自托管
-DBX 未使用 Apple 开发者证书签名，首次打开时 macOS 会阻止运行。解决方法：
+你也可以通过 Docker 部署 DBX，适合团队共享和服务器环境：
```bash
-xattr -cr /Applications/DBX.app
+docker run -d \
+ --name dbx \
+ -p 3000:3000 \
+ ghcr.io/t8y2/dbx:latest
```
-或者：**系统设置 → 隐私与安全性 → 仍要打开**。
+部署后通过浏览器访问 `http://localhost:3000` 即可使用。
## 创建第一个连接
@@ -59,7 +65,7 @@ xattr -cr /Applications/DBX.app
git clone https://github.com/t8y2/dbx.git
cd dbx
pnpm install
-pnpm tauri dev
+pnpm dev:tauri
```
### 构建
diff --git a/docs/guide/getting-started.md b/docs/content/docs/getting-started.mdx
similarity index 65%
rename from docs/guide/getting-started.md
rename to docs/content/docs/getting-started.mdx
index 382f1cd88..2a1574328 100644
--- a/docs/guide/getting-started.md
+++ b/docs/content/docs/getting-started.mdx
@@ -1,3 +1,8 @@
+---
+title: Getting Started
+description: Install DBX and create your first database connection.
+---
+
# Getting Started
## Install
@@ -27,15 +32,31 @@ Update:
scoop update dbx
```
-### macOS Note
+### Docker (Self-Hosted)
-DBX is not signed with an Apple Developer certificate. On first launch, macOS will block the app. To fix:
+You can run DBX as a self-hosted web application using Docker:
```bash
-xattr -cr /Applications/DBX.app
+docker run -d --name dbx -p 3000:3000 ghcr.io/t8y2/dbx:latest
```
-Or: **System Settings → Privacy & Security → Open Anyway**.
+Then open `http://localhost:3000` in your browser.
+
+For Docker Compose:
+
+```yaml
+services:
+ dbx:
+ image: ghcr.io/t8y2/dbx:latest
+ ports:
+ - "3000:3000"
+ volumes:
+ - dbx-data:/data
+ restart: unless-stopped
+
+volumes:
+ dbx-data:
+```
## Create Your First Connection
@@ -59,7 +80,7 @@ Or: **System Settings → Privacy & Security → Open Anyway**.
git clone https://github.com/t8y2/dbx.git
cd dbx
pnpm install
-pnpm tauri dev
+pnpm dev:tauri
```
### Build
diff --git a/docs/zh-CN/guide/mcp.md b/docs/content/docs/mcp.cn.mdx
similarity index 85%
rename from docs/zh-CN/guide/mcp.md
rename to docs/content/docs/mcp.cn.mdx
index f3fb5ada0..3a82f9c8c 100644
--- a/docs/zh-CN/guide/mcp.md
+++ b/docs/content/docs/mcp.cn.mdx
@@ -1,4 +1,7 @@
-# MCP 集成
+---
+title: MCP 集成
+description: 通过 MCP 协议让 AI 编程助手直接查询你的数据库。
+---
## 什么是 MCP？
@@ -49,10 +52,10 @@ npm install -g @dbx-app/mcp-server
| 助手 | 支持情况 | 配置方式 |
|---|---|---|
-| Claude Code | ✅ 原生支持 | `.mcp.json` |
-| Cursor | ✅ 支持 | `.cursor/mcp.json` |
-| Windsurf | ✅ 支持 | `.windsurfrules` |
-| VS Code + Copilot | ✅ 支持 | MCP 扩展 |
+| Claude Code | 原生支持 | `.mcp.json` |
+| Cursor | 支持 | `.cursor/mcp.json` |
+| Windsurf | 支持 | `.windsurfrules` |
+| VS Code + Copilot | 支持 | MCP 扩展 |
## 工具列表
@@ -161,16 +164,16 @@ MCP 查询支持 PostgreSQL 和 MySQL（及兼容数据库：Doris、StarRocks
## 常见问题
**MCP Server 连不上数据库**
-: 检查 DBX 中该连接是否能正常连接。MCP Server 使用相同的连接配置和密码。
+- 检查 DBX 中该连接是否能正常连接。MCP Server 使用相同的连接配置和密码。
**`dbx_open_table` 报 "DBX is not running"**
-: 需要先启动 DBX 桌面应用。UI 联动功能依赖 DBX 运行时的本地 HTTP 服务。
+- 需要先启动 DBX 桌面应用。UI 联动功能依赖 DBX 运行时的本地 HTTP 服务。
**连接名称找不到**
-: 连接名称匹配不区分大小写，但需要和 DBX 中配置的名称一致。用 `dbx_list_connections` 查看所有可用名称。
+- 连接名称匹配不区分大小写，但需要和 DBX 中配置的名称一致。用 `dbx_list_connections` 查看所有可用名称。
**查询超时**
-: MCP Server 的查询超时为 30 秒。如果查询较慢，考虑添加索引或简化查询。
+- MCP Server 的查询超时为 30 秒。如果查询较慢，考虑添加索引或简化查询。
## 系统要求
diff --git a/docs/guide/mcp.md b/docs/content/docs/mcp.mdx
similarity index 85%
rename from docs/guide/mcp.md
rename to docs/content/docs/mcp.mdx
index 44dc93bf5..35ec665aa 100644
--- a/docs/guide/mcp.md
+++ b/docs/content/docs/mcp.mdx
@@ -1,3 +1,8 @@
+---
+title: MCP Integration
+description: Let AI coding agents query your databases through the Model Context Protocol.
+---
+
# MCP Integration
## What is MCP?
@@ -49,10 +54,10 @@ Just ask your AI agent:
| Agent | Status | Configuration |
|---|---|---|
-| Claude Code | ✅ Native | `.mcp.json` |
-| Cursor | ✅ Supported | `.cursor/mcp.json` |
-| Windsurf | ✅ Supported | `.windsurfrules` |
-| VS Code + Copilot | ✅ Supported | MCP extension |
+| Claude Code | Native | `.mcp.json` |
+| Cursor | Supported | `.cursor/mcp.json` |
+| Windsurf | Supported | `.windsurfrules` |
+| VS Code + Copilot | Supported | MCP extension |
## Tools
@@ -161,16 +166,16 @@ MCP query support: PostgreSQL, MySQL, and compatible databases (Doris, StarRocks
## FAQ
**MCP Server can't connect to my database**
-: Check that the connection works in DBX first. The MCP Server uses the same config and credentials.
+: Check that the connection works in DBX first. The MCP Server uses the same config and credentials.
**`dbx_open_table` says "DBX is not running"**
-: Start the DBX desktop app first. UI integration requires DBX's local HTTP service.
+: Start the DBX desktop app first. UI integration requires DBX's local HTTP service.
**Connection name not found**
-: Connection name matching is case-insensitive but must match exactly. Use `dbx_list_connections` to see all available names.
+: Connection name matching is case-insensitive but must match exactly. Use `dbx_list_connections` to see all available names.
**Query timeout**
-: MCP Server has a 30-second query timeout. Consider adding indexes or simplifying your query.
+: MCP Server has a 30-second query timeout. Consider adding indexes or simplifying your query.
## Requirements
diff --git a/docs/content/docs/meta.cn.json b/docs/content/docs/meta.cn.json
new file mode 100644
index 000000000..943161d0e
--- /dev/null
+++ b/docs/content/docs/meta.cn.json
@@ -0,0 +1,27 @@
+{
+ "title": "DBX 文档",
+ "pages": [
+ "---介绍---",
+ "what-is-dbx",
+ "getting-started",
+ "databases",
+ "---核心功能---",
+ "query-editor",
+ "data-grid",
+ "schema-browser",
+ "---高级功能---",
+ "schema-diff",
+ "data-transfer",
+ "table-structure",
+ "field-lineage",
+ "table-import",
+ "sql-file",
+ "database-export",
+ "---AI 与自动化---",
+ "ai-assistant",
+ "mcp",
+ "---设置---",
+ "config-export",
+ "ssh-tunnel"
+ ]
+}
diff --git a/docs/content/docs/meta.json b/docs/content/docs/meta.json
new file mode 100644
index 000000000..691ff0ebe
--- /dev/null
+++ b/docs/content/docs/meta.json
@@ -0,0 +1,27 @@
+{
+ "title": "DBX Docs",
+ "pages": [
+ "---Introduction---",
+ "what-is-dbx",
+ "getting-started",
+ "databases",
+ "---Core Features---",
+ "query-editor",
+ "data-grid",
+ "schema-browser",
+ "---Advanced Features---",
+ "schema-diff",
+ "data-transfer",
+ "table-structure",
+ "field-lineage",
+ "table-import",
+ "sql-file",
+ "database-export",
+ "---AI & Automation---",
+ "ai-assistant",
+ "mcp",
+ "---Settings---",
+ "config-export",
+ "ssh-tunnel"
+ ]
+}
diff --git a/docs/zh-CN/guide/query-editor.md b/docs/content/docs/query-editor.cn.mdx
similarity index 92%
rename from docs/zh-CN/guide/query-editor.md
rename to docs/content/docs/query-editor.cn.mdx
index bd9d7b691..dc4ff30d3 100644
--- a/docs/zh-CN/guide/query-editor.md
+++ b/docs/content/docs/query-editor.cn.mdx
@@ -1,4 +1,7 @@
-# 查询编辑器
+---
+title: 查询编辑器
+description: 基于 CodeMirror 6 的 SQL 查询编辑器，提供语法高亮、智能补全和快捷操作。
+---
DBX 内置了基于 CodeMirror 6 的 SQL 查询编辑器，提供语法高亮、智能补全和快捷操作，帮助你高效编写和执行 SQL。
diff --git a/docs/guide/query-editor.md b/docs/content/docs/query-editor.mdx
similarity index 94%
rename from docs/guide/query-editor.md
rename to docs/content/docs/query-editor.mdx
index f682a69f3..4e5cc3abd 100644
--- a/docs/guide/query-editor.md
+++ b/docs/content/docs/query-editor.mdx
@@ -1,3 +1,8 @@
+---
+title: Query Editor
+description: Write and execute SQL with syntax highlighting, autocomplete, and query history.
+---
+
# Query Editor
The Query Editor is the primary workspace for writing and executing SQL in DBX. It is built on CodeMirror 6, providing a fast, modern editing experience with deep database awareness.
diff --git a/docs/zh-CN/guide/schema-browser.md b/docs/content/docs/schema-browser.cn.mdx
similarity index 91%
rename from docs/zh-CN/guide/schema-browser.md
rename to docs/content/docs/schema-browser.cn.mdx
index 089d1a708..fb2662d06 100644
--- a/docs/zh-CN/guide/schema-browser.md
+++ b/docs/content/docs/schema-browser.cn.mdx
@@ -1,4 +1,7 @@
-# 结构浏览
+---
+title: 结构浏览
+description: 树形结构浏览器，快速浏览和管理数据库中的所有对象。
+---
DBX 提供树形结构浏览器，让你可以快速浏览和管理数据库中的所有对象。
diff --git a/docs/guide/schema-browser.md b/docs/content/docs/schema-browser.mdx
similarity index 93%
rename from docs/guide/schema-browser.md
rename to docs/content/docs/schema-browser.mdx
index 709d76633..7d29338e4 100644
--- a/docs/guide/schema-browser.md
+++ b/docs/content/docs/schema-browser.mdx
@@ -1,3 +1,8 @@
+---
+title: Schema Browser
+description: Explore database structure with a navigable tree view, search, and context menus.
+---
+
# Schema Browser
The Schema Browser is the sidebar panel that lets you explore the structure of all your connected databases. It presents your database objects in a navigable tree and provides quick actions via context menus.
diff --git a/docs/zh-CN/guide/schema-diff.md b/docs/content/docs/schema-diff.cn.mdx
similarity index 91%
rename from docs/zh-CN/guide/schema-diff.md
rename to docs/content/docs/schema-diff.cn.mdx
index 3e0088bda..664421a5a 100644
--- a/docs/zh-CN/guide/schema-diff.md
+++ b/docs/content/docs/schema-diff.cn.mdx
@@ -1,4 +1,7 @@
-# Schema 对比
+---
+title: Schema 对比
+description: 比较两个数据库之间的结构差异，并生成同步 SQL。
+---
DBX 的 Schema 对比功能可以比较两个数据库之间的结构差异，并生成同步 SQL，帮助你快速对齐数据库结构。
diff --git a/docs/guide/schema-diff.md b/docs/content/docs/schema-diff.mdx
similarity index 80%
rename from docs/guide/schema-diff.md
rename to docs/content/docs/schema-diff.mdx
index ae0c4188f..e67bd4d9a 100644
--- a/docs/guide/schema-diff.md
+++ b/docs/content/docs/schema-diff.mdx
@@ -1,3 +1,8 @@
+---
+title: Schema Diff
+description: Compare database schemas and generate SQL to synchronize them.
+---
+
# Schema Diff
Schema Diff compares the structure of two databases and generates the SQL needed to synchronize them. This is useful for identifying differences between development and production environments, or between any two database instances.
@@ -27,6 +32,5 @@ You can review the generated SQL before taking any action.
Once you have reviewed the generated SQL, you can execute it directly within DBX against the target database. There is no need to copy the SQL to an external tool -- the sync can be completed in a single workflow.
-::: warning
-Schema sync can make destructive changes (such as dropping tables or columns). Always review the generated SQL carefully before executing, and consider backing up the target database first.
-:::
+> **Warning:**
+> Schema sync can make destructive changes (such as dropping tables or columns). Always review the generated SQL carefully before executing, and consider backing up the target database first.
diff --git a/docs/zh-CN/guide/sql-file.md b/docs/content/docs/sql-file.cn.mdx
similarity index 87%
rename from docs/zh-CN/guide/sql-file.md
rename to docs/content/docs/sql-file.cn.mdx
index 369bc9697..64a93aa66 100644
--- a/docs/zh-CN/guide/sql-file.md
+++ b/docs/content/docs/sql-file.cn.mdx
@@ -1,4 +1,7 @@
-# SQL 文件执行
+---
+title: SQL 文件执行
+description: 直接执行 .sql 文件，适用于运行数据库迁移脚本、初始化脚本或批量 SQL 操作。
+---
DBX 支持直接执行 `.sql` 文件，适用于运行数据库迁移脚本、初始化脚本或批量 SQL 操作。
diff --git a/docs/guide/sql-file.md b/docs/content/docs/sql-file.mdx
similarity index 91%
rename from docs/guide/sql-file.md
rename to docs/content/docs/sql-file.mdx
index 793a239eb..e23a389b5 100644
--- a/docs/guide/sql-file.md
+++ b/docs/content/docs/sql-file.mdx
@@ -1,3 +1,8 @@
+---
+title: SQL File Execution
+description: Run .sql files directly within DBX with progress tracking and cancellation support.
+---
+
# SQL File Execution
SQL File Execution lets you run `.sql` files directly within DBX, with progress tracking and the ability to cancel mid-execution. This is useful for running migration scripts, seed data, or database setup files.
diff --git a/docs/zh-CN/guide/ssh-tunnel.md b/docs/content/docs/ssh-tunnel.cn.mdx
similarity index 90%
rename from docs/zh-CN/guide/ssh-tunnel.md
rename to docs/content/docs/ssh-tunnel.cn.mdx
index 478a274bf..b27f8aa61 100644
--- a/docs/zh-CN/guide/ssh-tunnel.md
+++ b/docs/content/docs/ssh-tunnel.cn.mdx
@@ -1,4 +1,7 @@
-# SSH 隧道
+---
+title: SSH 隧道
+description: 通过 SSH 隧道安全地连接不允许直接远程访问的数据库服务器。
+---
当数据库服务器不允许直接远程访问时，你可以通过 SSH 隧道安全地连接。DBX 内置了 SSH 隧道支持，无需手动在终端中建立隧道。
diff --git a/docs/guide/ssh-tunnel.md b/docs/content/docs/ssh-tunnel.mdx
similarity index 86%
rename from docs/guide/ssh-tunnel.md
rename to docs/content/docs/ssh-tunnel.mdx
index 11539f3da..c69873ac6 100644
--- a/docs/guide/ssh-tunnel.md
+++ b/docs/content/docs/ssh-tunnel.mdx
@@ -1,3 +1,8 @@
+---
+title: SSH Tunnel
+description: Connect to databases through SSH tunnels for secure access to remote servers.
+---
+
# SSH Tunnel
DBX can connect to databases through an SSH tunnel, allowing you to securely access database servers that are not directly reachable from your machine. This is common in production environments where the database is behind a firewall or on a private network.
@@ -31,9 +36,8 @@ If your private key is protected by a passphrase, DBX will prompt you to enter i
By default, the SSH tunnel listens only on `localhost` (`127.0.0.1`). If you enable the **Expose to LAN** option, the tunnel binds to `0.0.0.0`, making it accessible to other devices on your local network.
-::: warning
-Exposing the tunnel to your LAN means any device on the same network can access the tunneled database port. Only enable this on trusted networks.
-:::
+> **Warning:**
+> Exposing the tunnel to your LAN means any device on the same network can access the tunneled database port. Only enable this on trusted networks.
## How It Works
diff --git a/docs/zh-CN/guide/table-import.md b/docs/content/docs/table-import.cn.mdx
similarity index 88%
rename from docs/zh-CN/guide/table-import.md
rename to docs/content/docs/table-import.cn.mdx
index fc30dec6c..01c7e8ae5 100644
--- a/docs/zh-CN/guide/table-import.md
+++ b/docs/content/docs/table-import.cn.mdx
@@ -1,4 +1,7 @@
-# 表数据导入
+---
+title: 表数据导入
+description: 将外部文件中的数据导入到数据库表中，支持 CSV、TSV、JSON、Excel 格式。
+---
DBX 支持将外部文件中的数据导入到数据库表中，适用于批量数据录入和数据迁移场景。
diff --git a/docs/guide/table-import.md b/docs/content/docs/table-import.mdx
similarity index 79%
rename from docs/guide/table-import.md
rename to docs/content/docs/table-import.mdx
index 5d31a8504..ab5533f5a 100644
--- a/docs/guide/table-import.md
+++ b/docs/content/docs/table-import.mdx
@@ -1,3 +1,8 @@
+---
+title: Table Import
+description: Import data from CSV, TSV, JSON, and Excel files into database tables.
+---
+
# Table Import
Table Import lets you load data from local files into a database table. It supports common file formats and provides column mapping to ensure data lands in the right place.
@@ -32,6 +37,5 @@ Unmapped file columns are skipped. Unmapped table columns receive their default
| **Append** | Insert the imported rows into the table alongside existing data. |
| **Truncate then import** | Delete all existing rows from the table first, then insert the imported data. |
-::: warning
-Truncate mode permanently removes all existing data in the target table before importing. Make sure this is the intended behavior before proceeding.
-:::
+> **Warning:**
+> Truncate mode permanently removes all existing data in the target table before importing. Make sure this is the intended behavior before proceeding.
diff --git a/docs/zh-CN/guide/table-structure.md b/docs/content/docs/table-structure.cn.mdx
similarity index 90%
rename from docs/zh-CN/guide/table-structure.md
rename to docs/content/docs/table-structure.cn.mdx
index b5b4221a4..96003b84c 100644
--- a/docs/zh-CN/guide/table-structure.md
+++ b/docs/content/docs/table-structure.cn.mdx
@@ -1,4 +1,7 @@
-# 表结构编辑器
+---
+title: 表结构编辑器
+description: 可视化的表结构编辑器，无需手写 DDL 语句即可管理表的列和索引。
+---
DBX 提供可视化的表结构编辑器，让你无需手写 DDL 语句即可管理表的列和索引。
diff --git a/docs/guide/table-structure.md b/docs/content/docs/table-structure.mdx
similarity index 92%
rename from docs/guide/table-structure.md
rename to docs/content/docs/table-structure.mdx
index f7d3af791..25d3c7798 100644
--- a/docs/guide/table-structure.md
+++ b/docs/content/docs/table-structure.mdx
@@ -1,3 +1,8 @@
+---
+title: Table Structure Editor
+description: Visually modify table schemas -- add, edit, and delete columns and indexes.
+---
+
# Table Structure Editor
The Table Structure Editor provides a visual interface for modifying table schemas. Instead of writing `ALTER TABLE` statements by hand, you can add, modify, and delete columns and indexes through a form-based UI.
diff --git a/docs/content/docs/what-is-dbx.cn.mdx b/docs/content/docs/what-is-dbx.cn.mdx
new file mode 100644
index 000000000..db121fcf9
--- /dev/null
+++ b/docs/content/docs/what-is-dbx.cn.mdx
@@ -0,0 +1,46 @@
+---
+title: 什么是 DBX？
+description: DBX 是一款开源、轻量、跨平台的数据库管理工具，基于 Tauri 2 和 Rust 构建。
+---
+
+DBX 是一款开源、轻量、跨平台的数据库管理工具，基于 [Tauri 2](https://tauri.app/) 和 Rust 构建。
+
+## 为什么选择 DBX？
+
+- **轻量** — 安装包约 15 MB，不内嵌 Chromium
+- **多数据库** — 一个工具管理 MySQL、PostgreSQL、SQLite、Redis、MongoDB 等 25+ 种数据库
+- **AI 驱动** — 内置 AI 助手 + MCP Server 对接外部 AI 编程助手
+- **安全** — 密码存储在系统钥匙串，支持 SSH 隧道，加密配置导出
+- **跨平台** — macOS、Windows、Linux
+- **Docker 自托管** — 支持通过 Docker 部署，适合团队共享和服务器环境
+
+## 核心功能
+
+- SQL 查询编辑器（语法高亮、智能补全、查询历史）
+- 数据表格（虚拟滚动、行内编辑、导出）
+- 结构浏览（树形视图、搜索、右键菜单）
+- Schema 图 / ER 图
+- 执行计划可视化
+- 表结构编辑器（可视化 DDL）
+- Schema 对比与同步
+- 数据迁移（跨引擎传输）
+- 数据导入（CSV、TSV、JSON、Excel）
+- 数据库导出（DDL + 数据）
+- 字段血缘分析
+- 配置导出/导入（加密传输）
+- AI 助手（自然语言转 SQL、优化、修复）
+- MCP Server（对接 Claude Code、Cursor 等）
+
+## 技术栈
+
+| 层级 | 技术 |
+|---|---|
+| 框架 | [Tauri 2](https://tauri.app/) |
+| 前端 | [Vue 3](https://vuejs.org/) + TypeScript |
+| UI | [shadcn-vue](https://www.shadcn-vue.com/) + Tailwind CSS |
+| 编辑器 | [CodeMirror 6](https://codemirror.net/) |
+| 后端 | Rust + sqlx / tiberius / redis-rs / mongodb |
+
+## 开源协议
+
+[AGPL-3.0](https://github.com/t8y2/dbx/blob/main/LICENSE)
diff --git a/docs/content/docs/what-is-dbx.mdx b/docs/content/docs/what-is-dbx.mdx
new file mode 100644
index 000000000..2cfb0d264
--- /dev/null
+++ b/docs/content/docs/what-is-dbx.mdx
@@ -0,0 +1,50 @@
+---
+title: What is DBX?
+description: An open-source, lightweight, cross-platform database management tool built with Tauri 2 and Rust.
+---
+
+# What is DBX?
+
+DBX is an open-source, lightweight, cross-platform database management tool built with [Tauri 2](https://tauri.app/) and Rust.
+
+
+
+
-
-
-
-
- 
- 
- 
-