diff --git a/README.md b/README.md index 5eeec16..6ac3c3f 100644 --- a/README.md +++ b/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. 其余审核的事情只需要交给我们来做就好了 **编写内容的时候需要注意的事情**: -1. 中文与英文之间请保留一个空格,如`测试 test 测试` +1. 中文与英文之间请保留一个空格,如`测试 test 测试`,可以使用 [AutoCorrect](https://github.com/huacnlee/autocorrect) 进行检查和修改 ## Author diff --git a/app/(home)/page.tsx b/app/(home)/page.tsx index 94138d0..6e82bd9 100644 --- a/app/(home)/page.tsx +++ b/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 {

- "Mix Space 的文档非常详细,总有新的内容和功能在开发中。我自己也在用Mix Space,博文加手记的记录个人空间体验非常不错。它改变了我的写作方式。" + "Mix Space 的文档非常详细,总有新的内容和功能在开发中。我自己也在用 Mix Space,博文加手记的记录个人空间体验非常不错。它改变了我的写作方式。"

=> { const indexId = 'k2hnq39jnt7u8l41bfv0ezhd'; if (!apiKey) { - console.log('未找到 Orama 私钥, 跳过索引更新'); + console.log('未找到 Orama 私钥,跳过索引更新'); return; } @@ -24,9 +24,9 @@ const updateSearchIndexes = async (): Promise => { documents: records, }); - console.log(`搜索索引更新完成: ${records.length} 条记录`); + console.log(`搜索索引更新完成:${records.length} 条记录`); } catch (error) { - console.error('更新搜索索引时发生错误:', error); + console.error('更新搜索索引时发生错误:', error); } } diff --git a/app/layout.config.tsx b/app/layout.config.tsx index dca549e..bbdb4db 100644 --- a/app/layout.config.tsx +++ b/app/layout.config.tsx @@ -51,7 +51,7 @@ export const baseOptions: BaseLayoutProps = { { icon: , 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: , 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: , 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: , 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: , text: '开发指南', - description: '了解如何为Mix Space开发后端和前端', + description: '了解如何为 Mix Space 开发后端和前端', url: '/docs/development', menu: { className: 'lg:col-start-3', diff --git a/bun.lockb b/bun.lockb old mode 100644 new mode 100755 index 958ff07..a830f52 Binary files a/bun.lockb and b/bun.lockb differ diff --git a/content/docs/core/community.mdx b/content/docs/core/community.mdx index 3b57d67..7c5c063 100644 --- a/content/docs/core/community.mdx +++ b/content/docs/core/community.mdx @@ -35,13 +35,13 @@ import { FileText, Video } from 'lucide-react' } target="_blank" /> } target="_blank" @@ -54,7 +54,7 @@ import { FileText, Video } from 'lucide-react' target="_blank" /> } target="_blank" diff --git a/content/docs/core/extra.mdx b/content/docs/core/extra.mdx index 8ce3ff3..0cee931 100644 --- a/content/docs/core/extra.mdx +++ b/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,7 +286,7 @@ pnpm prod:pm2 和编辑其他环境变量一样,在 `services.app` 的 `environment` 部分添加你需要传入的值,如下所示: -```yaml +```yml services: app: container_name: mx-server @@ -294,9 +294,9 @@ services: 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 diff --git a/content/docs/markdown/meta.json b/content/docs/markdown/meta.json index d908dc3..1c4aa92 100644 --- a/content/docs/markdown/meta.json +++ b/content/docs/markdown/meta.json @@ -1,6 +1,6 @@ { "index": "Markdown", - "description": "探索Mix Space的Markdown 扩展语法", + "description": "探索 Mix Space 的 Markdown 扩展语法", "icon": "Pencil", "root": true, "pages": [ diff --git a/content/docs/themes/kami.mdx b/content/docs/themes/kami.mdx index ca911a0..82c2b8d 100644 --- a/content/docs/themes/kami.mdx +++ b/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。 ### 克隆项目 diff --git a/content/docs/themes/shiro/deploy.mdx b/content/docs/themes/shiro/deploy.mdx index a495cf3..8dcf8bc 100644 --- a/content/docs/themes/shiro/deploy.mdx +++ b/content/docs/themes/shiro/deploy.mdx @@ -17,7 +17,7 @@ import { ToGitHub } from 'app/components/ToGitHub' 自 Core v7 起,已抛弃 Clerk,取而代之的是 GitHub 和 Google 的 OAuth 2.0, - 配置步骤请参考[OAuth 2.0](/usage/oauth) + 配置步骤请参考 [OAuth 2.0](/usage/oauth) ~~请注意,Shiro 主题的部署教程与初版有所不同,如果你已经部署过 Shiro 主题,请重新阅读本文档(尤其是填入配置文件环节,配置有所变化),并阅读 diff --git a/content/docs/themes/shiro/extra.mdx b/content/docs/themes/shiro/extra.mdx index d34c903..ad02256 100644 --- a/content/docs/themes/shiro/extra.mdx +++ b/content/docs/themes/shiro/extra.mdx @@ -233,7 +233,7 @@ LOG_ENABLE=true 其中 svg 后填生成的 svg 代码,可通过 [此网站](https://danmarshall.github.io/google-font-to-svg-path/) 进行生成。 - 受限于 Json 语法规则,此处 svg 代码需替换所有的`"`为`\"`,否则会报错。 + 受限于 Json 语法规则,此处 svg 代码需替换所有的 `"` 为 `\"`,否则会报错。 ```json {18,19,20} diff --git a/package.json b/package.json index a3144fe..6912312 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ "@orama/tokenizers": "^3.0.1", "@oramacloud/client": "^1.3.19", "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",