使用指南 ​

本主题为 Vitepress blog 主题，请确保您已了解 Vitepress 的基本使用方式。更多信息请参见 Vitepress 官网。

有任何关于本主题的缺陷报告与功能建议，可以发起 Issues。

如果您有其他相关的想法与问题，可前往 Discussions。

快速开始 Get started ​

安装主题 Install ​

初始化新博客 ​

如果您的是新建博客，可以通过如下命令快速安装。根据您的包管理器，选择对应命令进行初始化

npm create async-theme@latest my-first-blog

npm create async-theme@latest my-first-blog

yarn create async-theme my-first-blog

yarn create async-theme my-first-blog

pnpm create async-theme@latest my-first-blog

pnpm create async-theme@latest my-first-blog

bunx create-async-theme@latest my-first-blog --bun

bunx create-async-theme@latest my-first-blog --bun

在已有客安装 ​

如果您需要将已有项目中使用主题，可以通过如下几种方式安装

安装 Npm 包方式 ​

进入您的博客根目录，添加 vitepress-theme-async

npm i vitepress-theme-async@latest

npm i vitepress-theme-async@latest

将主题包复制到本地 ​

将 package/vitepress-theme-async 目录下代码复制到 .vitepress/theme 目录中即可。

启用主题 Use ​

• 使用 Npm 安装方式

在如下文件下添加对应代码

import { defineConfig } from "vitepress-theme-async/config";

export default defineConfig({
	themeConfig: {
		// 在此添加配置
	},
});

import { defineConfig } from "vitepress-theme-async/config";

export default defineConfig({
	themeConfig: {
		// 在此添加配置
	},
});

import ThemeAsync from "vitepress-theme-async";

export default ThemeAsync;

import ThemeAsync from "vitepress-theme-async";

export default ThemeAsync;

• 复制到本地方式

如果您是将文件复制到本地，修改如下:

import { defineConfig } from "vitepress-theme-async/config";  
import { defineConfig } from "./theme/config";  

export default defineConfig({
	themeConfig: {
		// 在此添加配置
	},
});

import { defineConfig } from "vitepress-theme-async/config";  
import { defineConfig } from "./theme/config";  

export default defineConfig({
	themeConfig: {
		// 在此添加配置
	},
});

import ThemeAsync from "vitepress-theme-async"; 
import ThemeAsync from "./main";  

export default ThemeAsync;

import ThemeAsync from "vitepress-theme-async"; 
import ThemeAsync from "./main";  

export default ThemeAsync;

配置主题 Config ​

配置主题 请看这里

TS 类型提示 ​

在 tsconfig 文件里添加 vitepress-theme-async 到 types 字段里。

{
  "compilerOptions": {
    //...
    "types": ["vitepress-theme-async"]
  },
}

{
  "compilerOptions": {
    //...
    "types": ["vitepress-theme-async"]
  },
}

v0.0.28+ 版本，也可以修改 tsconfig 配置的 moduleResolution 字段，切换到支持识别 package.json 的 exports 字段的模式。

MCP Server ​

将下面 JSON 配置添加到 IDE 对应的 MCP 配置文件里，就可以让 AI 帮助修改配置文件里

你只要告诉 AI 你想要通过 修改主题配置信息，示例：

• “主题 vitepress-theme-async 有哪些配置信息”
• “帮我修改 banner 配置, 将背景图换成 xxxx ”
• “帮我修改 关于我 页面配置”
• “.......”

{
  "mcpServers": {
    "async配置": {
      "command": "npx",
      "args": [
        "-y",
        "vitepress-theme-async-mcp-server@latest",
      ]
    }
  }
}

{
  "mcpServers": {
    "async配置": {
      "command": "npx",
      "args": [
        "-y",
        "vitepress-theme-async-mcp-server@latest",
      ]
    }
  }
}