Merge branch 'main' of https://github.com/mx-space/docs

.github/workflows/deploy.yml

@@ -42,6 +42,9 @@ jobs:
       - name: Sync search index
         run: |
           bun run sync-search
+      - name: Generate sitemap
+        run: |
+          bun run generate-sitemap  
         env:
           ORAMA_PRIVATE_API_KEY: ${{ secrets.ORAMA_PRIVATE_API_KEY }}
       - name: Add CNAME

README.md

@@ -2,7 +2,7 @@
 
 ## Contributing 贡献
 
-这个站点使用的是 [Pumadocs](https://fumadocs.vercel.app) 程序。站点内容使用 MDX 编写，文档文件在 `/content/docs` 文件夹中。如果只有一些简单的修改，你可以直接在 GitHub 网页端进行修改并新建一个 Pull Request.
+这个站点使用的是 [Fumadocs](https://fumadocs.vercel.app) 程序。站点内容使用 MDX 编写，文档文件在 `/content/docs` 文件夹中。如果只有一些简单的修改，你可以直接在 GitHub 网页端进行修改并新建一个 Pull Request.
 
 在本地开发中，[bun](https://bun.sh/) 被选用为项目的包管理器，你需要使用 bun 安装依赖：
 
@@ -14,7 +14,7 @@
 
 ## Working on the content 修改文字
 
-- 关于支持的 MDX 扩展和在 MDX 内部使用 React 语法的能力，请参阅 Pumadocs 文档
+- 关于支持的 MDX 扩展和在 MDX 内部使用 React 语法的能力，请参阅 Fumadocs 文档
 - 有关编写和维护文档内容的规则和建议，请参阅编写指南。
 
 ## Guide 编写指南
@@ -23,12 +23,12 @@
 
 1. 克隆此项目
 2. 在 `content/docs` 文件夹中，新增一个文件夹，请语义化命名，假设为 `test`
-3. 编写内容，具体可以借鉴其他文档文件夹，请务必设置了父文件夹的 `meta.json` 文件，具体请参考 Pumadocs 文档
+3. 编写内容，具体可以借鉴其他文档文件夹，请务必设置了父文件夹的 `meta.json` 文件，具体请参考 Fumadocs 文档
 4. 创建 Pull Request. 其余审核的事情只需要交给我们来做就好了
 
 **<u>编写内容的时候需要注意的事情</u>**：
 
-1. 中文与英文之间请保留一个空格，如`测试 test 测试`
+1. 中文与英文之间请保留一个空格，如`测试 test 测试`，可以使用 [AutoCorrect](https://github.com/huacnlee/autocorrect) 进行检查和修改
 
 ## Author
 

app/(home)/page.tsx

@@ -30,7 +30,7 @@ import {
 const highlights = [
   {
     icon: RocketIcon,
-    heading: "基于Next.js",
+    heading: "基于 Next.js",
     description: "内置代码分割和图片优化，服务器端渲染（SSR）支持，性能强劲，速度快，SEO 友好。"
   },
   {
@@ -46,12 +46,12 @@ const highlights = [
   {
     icon: PencilLine,
     heading: "Markdown 语法支持",
-    description: "Mix Space 原生支持Markdown语法，也支持自定义 Markdown 内语法，您可以使用自定义语法来丰富您的内容。"
+    description: "Mix Space 原生支持 Markdown 语法，也支持自定义 Markdown 内语法，您可以使用自定义语法来丰富您的内容。"
   },
   {
     icon: KeyboardIcon,
     heading: "后台云函数配置",
-    description: "无限扩展、无限可能，通过Core内置的云函数配置功能实现歌单解析，追番列表等功能，还有更多。"
+    description: "无限扩展、无限可能，通过 Core 内置的云函数配置功能实现歌单解析，追番列表等功能，还有更多。"
   },
   {
     icon: PersonStandingIcon,
@@ -292,7 +292,7 @@ function Feedback(): React.ReactElement {
         </div>
         <div className="rounded-xl border bg-gradient-to-b from-secondary/50 p-6 shadow-lg hover:shadow-xl transition-shadow">
           <p className="text-base font-medium mb-6">
-            "Mix Space 的文档非常详细，总有新的内容和功能在开发中。我自己也在用Mix Space，博文加手记的记录个人空间体验非常不错。它改变了我的写作方式。"
+            "Mix Space 的文档非常详细，总有新的内容和功能在开发中。我自己也在用 Mix Space，博文加手记的记录个人空间体验非常不错。它改变了我的写作方式。"
           </p>
           <div className="flex items-center gap-3">
             <Image

app/api/search/route.ts

@@ -9,7 +9,7 @@ const updateSearchIndexes = async (): Promise<void> => {
   const indexId = 'k2hnq39jnt7u8l41bfv0ezhd'; 
 
   if (!apiKey) {
-    console.log('未找到 Orama 私钥, 跳过索引更新');
+    console.log('未找到 Orama 私钥，跳过索引更新');
     return;
   }
 
@@ -24,9 +24,9 @@ const updateSearchIndexes = async (): Promise<void> => {
       documents: records,
     });
 
-    console.log(`搜索索引更新完成: ${records.length} 条记录`);
+    console.log(`搜索索引更新完成：${records.length} 条记录`);
   } catch (error) {
-    console.error('更新搜索索引时发生错误:', error);
+    console.error('更新搜索索引时发生错误：', error);
   }
 }
 

app/layout.config.tsx

@@ -51,7 +51,7 @@ export const baseOptions: BaseLayoutProps = {
         {
           icon: <BookMarked />,
           text: '使用文档',
-          description: '了解你的Mix Space如何使用',
+          description: '了解你的 Mix Space 如何使用',
           url: '/docs/usage',
           menu: {
             className: 'md:row-span-2',
@@ -60,7 +60,7 @@ export const baseOptions: BaseLayoutProps = {
         {
           icon: <Server />,
           text: '后端部署',
-          description: '部署Mix Space的后端部分',
+          description: '部署 Mix Space 的后端部分',
           url: '/docs/core',          
           menu: {
             className: 'lg:col-start-2',
@@ -69,7 +69,7 @@ export const baseOptions: BaseLayoutProps = {
         {
           icon: <PaintRoller />,
           text: '前端主题',
-          description: '部署Mix Space多彩的前端主题',
+          description: '部署 Mix Space 多彩的前端主题',
           url: '/docs/themes',
           menu: {
             className: 'lg:col-start-2',
@@ -78,7 +78,7 @@ export const baseOptions: BaseLayoutProps = {
         {
           icon: <Pencil />,
           text: 'Markdown',
-          description: '了解Mix Space的Markdown 语法',
+          description: '了解 Mix Space 的 Markdown 语法',
           url: '/docs/markdown',
           menu: {
             className: 'lg:col-start-3 lg:row-start-1',
@@ -87,7 +87,7 @@ export const baseOptions: BaseLayoutProps = {
         {
           icon: <Cpu />,
           text: '开发指南',
-          description: '了解如何为Mix Space开发后端和前端',
+          description: '了解如何为 Mix Space 开发后端和前端',
           url: '/docs/development',
           menu: {
             className: 'lg:col-start-3',

app/layout.tsx

@@ -2,9 +2,39 @@ import './global.css';
 import { Provider } from './components/provider';
 import type { ReactNode } from 'react';
 
+export const metadata = {
+  title: {
+    template: '%s - Mix Space 文档',
+    default: 'Mix Space - 现代化的个人空间解决方案'
+  },
+  description: 'Mix Space 是一个小型个人空间站点程序，采用前后端分离设计，适合喜欢写作的你。',
+  keywords: ['Mix Space', '个人博客', '个人空间', '开源博客', 'Next.js', 'React', 'TypeScript'],
+  authors: [{ name: 'Mix Space Team' }],
+  openGraph: {
+    title: 'Mix Space Documentation',
+    description: '探索 Mix Space',
+    url: 'https://mx-space.js.org',
+    siteName: 'Mix Space Docs',
+    locale: 'zh_CN',
+    type: 'website',
+  }
+}
+
 export default function Layout({ children }: { children: ReactNode }) {
   return (
     <html lang="zh-CN" suppressHydrationWarning>
+      <head>
+        <title>Mix Space - 现代化的个人空间解决方案</title>
+        <meta name="description" content="Mix Space 是一个小型个人空间站点程序，采用前后端分离设计，适合喜欢写作的你。" />
+        <meta name="keywords" content="Mix Space, 个人博客, 个人空间, 开源博客, Next.js, React, TypeScript" />
+        <meta name="author" content="Mix Space Team" />
+        <meta property="og:title" content="Mix Space Documentation" />
+        <meta property="og:description" content="探索 Mix Space" />
+        <meta property="og:url" content="https://mx-space.js.org" />
+        <meta property="og:site_name" content="Mix Space Docs" />
+        <meta property="og:locale" content="zh_CN" />
+        <meta property="og:type" content="website" />
+      </head>
       <body>
         <Provider>
           {children}

content/docs/core/community.mdx

@@ -35,13 +35,13 @@ import { FileText, Video } from 'lucide-react'
 
 <Card
   title="使用 Mix Space × Zeabur 搭建自己的个人空间"
-  href="https://lab.imgb.space/post/mxspace-on-zeabur/"
+  href="https://lab.gb0.dev/post/mxspace-on-zeabur/"
   icon={<FileText />}
   target="_blank"
 />
 
 <Card
-  title="使用Termux搭建Mix-Space | By Rinne"
+  title="使用 Termux 搭建 Mix-Space | By Rinne"
   href="https://www.rinne.in/posts/default/deploy-mxspace-with-termux"
   icon={<FileText />}
   target="_blank"
@@ -54,7 +54,7 @@ import { FileText, Video } from 'lucide-react'
   target="_blank"
 />
 <Card
-  title="Shiro部署如此简单？！"
+  title="Shiro 部署如此简单？！"
   href="https://blog.yoruzzz.cn/posts/%E5%BB%BA%E7%AB%99/shiro"
   icon={<FileText />}
   target="_blank"

content/docs/core/extra.mdx

@@ -217,7 +217,7 @@ server {
 
 和编辑其他环境变量一样，在 `service.app` 的 `environment` 部分添加你需要传入的值，如下所示：
 
-```yml {9-10}
+```yml
 services:
   app:
     container_name: mx-server
@@ -226,8 +226,8 @@ services:
       - TZ=Asia/Shanghai
       - NODE_ENV=production
       - DB_HOST=mongo
-      - REDIS_HOST=远端地址
-      - REDIS_PASSWORD=redis?passwd
+      - REDIS_HOST=远端地址 // [!code highlight]
+      - REDIS_PASSWORD=redis?passwd // [!code highlight]
       - ALLOWED_ORIGINS=localhost
       - JWT_SECRET=YOUR_SUPER_SECURED_JWT_SECRET_STRING
     volumes:
@@ -286,17 +286,17 @@ pnpm prod:pm2
 
 和编辑其他环境变量一样，在 `services.app` 的 `environment` 部分添加你需要传入的值，如下所示：
 
-```yaml 
+```yml 
 services:
   app:
     container_name: mx-server
     image: innei/mx-server:latest
     environment:
       - TZ=Asia/Shanghai
       - NODE_ENV=production
-      - DB_HOST=远端地址
-      - DB_USER=mongodb-test
-      - DB_PASSWORD=db?passwd
+      - DB_HOST=远端地址 // [!code highlight]
+      - DB_USER=mongodb-test // [!code highlight]
+      - DB_PASSWORD=db?passwd // [!code highlight]
       - REDIS_HOST=redis
       - ALLOWED_ORIGINS=localhost
       - JWT_SECRET=YOUR_SUPER_SECURED_JWT_SECRET_STRING

content/docs/markdown/meta.json

@@ -1,6 +1,6 @@
 {
     "index": "Markdown",
-    "description": "探索Mix Space的Markdown 扩展语法",
+    "description": "探索 Mix Space 的 Markdown 扩展语法",
     "icon": "Pencil",
     "root": true,
     "pages": [

content/docs/themes/kami.mdx

@@ -36,7 +36,7 @@ import { Step, Steps } from 'fumadocs-ui/components/steps';
 ```bash
 uname -r
 ```
-如果你的内核版本小于 4.19，请升级内核。或者使用最新的 Ubuntu / Debian 。
+如果你的内核版本小于 4.19，请升级内核。或者使用最新的 Ubuntu / Debian。
 </Step>
 <Step>
 ### 克隆项目

content/docs/themes/shiro/deploy.mdx

@@ -17,7 +17,7 @@ import { ToGitHub } from 'app/components/ToGitHub'
 
 <Callout type="warn">
   自 Core v7 起，已抛弃 Clerk，取而代之的是 GitHub 和 Google 的 OAuth 2.0，
-  配置步骤请参考[OAuth 2.0](/usage/oauth)
+  配置步骤请参考 [OAuth 2.0](/usage/oauth)
 
   ~~请注意，Shiro 主题的部署教程与初版有所不同，如果你已经部署过 Shiro
   主题，请重新阅读本文档（尤其是填入配置文件环节，配置有所变化），并阅读

content/docs/themes/shiro/extra.mdx

@@ -233,7 +233,7 @@ LOG_ENABLE=true
 其中 svg 后填生成的 svg 代码，可通过 [此网站](https://danmarshall.github.io/google-font-to-svg-path/) 进行生成。
 
 <Callout type="warning">
-  受限于 Json 语法规则，此处 svg 代码需替换所有的`"`为`\"`，否则会报错。
+  受限于 Json 语法规则，此处 svg 代码需替换所有的 `"` 为 `\"`，否则会报错。
 </Callout>
 
 ```json {18,19,20}

next.config.mjs

@@ -9,6 +9,14 @@ const config = {
   images: {
     domains: ['github.com', 'avatars.githubusercontent.com', 'pan.vinua.cn'],
     unoptimized: true
+  },
+  async rewrites() {
+    return [
+      {
+        source: '/sitemap.xml',
+        destination: '/api/sitemap'
+      }
+    ]
   }
 };
 

package.json

@@ -3,19 +3,23 @@
   "version": "0.0.0",
   "private": true,
   "scripts": {
-    "build": "next build",
+    "build": "next build && pnpm generate-sitemap",
     "dev": "next dev --turbo",
     "start": "next start",
     "postinstall": "fumadocs-mdx",
     "sync-search": "bun run sync-index.mjs",
-    "commit": "cz"
+    "commit": "cz",
+    "generate-sitemap": "tsx scripts/generate-sitemap.ts"
   },
   "dependencies": {
     "@orama/orama": "^3.0.1",
     "@orama/react-components": "^0.1.11",
     "@orama/tokenizers": "^3.0.1",
     "@oramacloud/client": "^1.3.19",
+    "@types/prettier": "^3.0.0",
+    "autocorrect-node": "^2.13.0",
     "commitizen": "^4.3.1",
+    "autocorrect-node": "^2.13.0",
     "copy-to-clipboard": "^3.3.3",
     "cz-conventional-changelog": "^3.3.0",
     "dotenv": "^16.4.5",
@@ -24,6 +28,7 @@
     "fumadocs-mdx": "11.1.1",
     "fumadocs-typescript": "^3.0.1",
     "fumadocs-ui": "14.2.0",
+    "globby": "^14.0.2",
     "lucide-react": "^0.454.0",
     "next": "15.0.2",
     "react": "^18.3.1",
@@ -39,7 +44,8 @@
     "@types/mdx": "^2.0.13",
     "autoprefixer": "^10.4.20",
     "postcss": "^8.4.47",
-    "tailwindcss": "^3.4.14"
+    "tailwindcss": "^3.4.14",
+    "tsx": "^4.7.1"
   },
   "config": {
     "commitizen": {