在 Docusaurus 中使用 Google Analytics 插件,可以帮助你跟踪网站的访问情况和用户行为。以下是配置和使用 Google Analytics 插件的步骤:
1. 获取 Google Analytics 追踪 ID
首先,你需要有一个 Google Analytics 账号,并为你的网站创建一个新的属性来获取追踪 ID(通常形式为 UA-XXXXXXXXX-X
或 G-XXXXXXXXXX
)。
2. 安装 Docusaurus Google Analytics 插件
Docusaurus 提供了官方的 Google Analytics 插件。你可以通过 npm 或 yarn 安装这个插件。
npm install @docusaurus/plugin-google-gtag
# 或者
yarn add @docusaurus/plugin-google-gtag
3. 配置插件
在你的 Docusaurus 项目根目录下找到 docusaurus.config.js
文件,并添加 Google Analytics 插件的配置。
module.exports = {
// 其他配置
plugins: [
[
'@docusaurus/plugin-google-gtag',
{
trackingID: '你的追踪ID', // 替换为你的 Google Analytics 追踪 ID
anonymizeIP: true, // 可选,是否匿名化 IP
},
],
],
// 其他配置
};
4. 验证配置
确保所有配置已正确完成,然后重新启动你的 Docusaurus 开发服务器:
npm start
# 或者
yarn start
打开浏览器的开发者工具,确保 Google Analytics 脚本已经加载并发送了数据请求。你可以在 Google Analytics 实时报告中查看是否有数据流入。
完整示例
以下是一个完整的 docusaurus.config.js
示例,其中包括了基本配置和 Google Analytics 插件配置:
// docusaurus.config.js
module.exports = {
title: '我的网站',
tagline: '我的项目描述',
url: 'https://你的域名.com',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon.ico',
organizationName: '你的GitHub用户名或组织名', // 通常是GitHub用户名
projectName: '你的项目名', // 通常是repo名
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/你的GitHub用户名/你的项目名/edit/main/docs/',
},
blog: {
showReadingTime: true,
editUrl: 'https://github.com/你的GitHub用户名/你的项目名/edit/main/blog/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
},
],
],
plugins: [
[
'@docusaurus/plugin-google-gtag',
{
trackingID: '你的追踪ID', // 替换为你的 Google Analytics 追踪 ID
anonymizeIP: true, // 可选,是否匿名化 IP
},
],
],
};
通过这些步骤,你应该能够成功在 Docusaurus 网站中集成 Google Analytics 插件,并开始跟踪访问数据和用户行为。