在ShowDoc项目中集成Google Analytics统计代码的方法

2025-05-18 18:27:59作者：牧宁李

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具

项目地址：https://gitcode.com/gh_mirrors/sh/showdoc

前言

Google Analytics（GA）是网站流量分析的重要工具，通过在网站中嵌入GA跟踪代码，我们可以获取用户访问量、用户行为等关键数据。对于使用ShowDoc搭建文档系统的用户来说，集成GA统计功能能够帮助更好地了解文档的使用情况。

ShowDoc项目中的GA集成方法

在ShowDoc项目中，要实现GA统计功能，需要在两个关键文件中添加GA跟踪代码：

web_src/index.html - 这是ShowDoc前端源码的入口文件
web/index.html - 这是ShowDoc编译后的前端入口文件

具体操作步骤

1. 获取GA跟踪代码

首先需要从Google Analytics管理后台获取跟踪代码片段。通常格式如下：

<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=GA_MEASUREMENT_ID"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());
  gtag('config', 'GA_MEASUREMENT_ID');
</script>

2. 修改ShowDoc前端文件

将上述代码添加到以下两个文件的<head>部分：

web_src/index.html文件修改：

<head>
  <!-- 其他meta标签 -->
  <!-- Google Analytics代码 -->
  <script async src="https://www.googletagmanager.com/gtag/js?id=GA_MEASUREMENT_ID"></script>
  <script>
    window.dataLayer = window.dataLayer || [];
    function gtag(){dataLayer.push(arguments);}
    gtag('js', new Date());
    gtag('config', 'GA_MEASUREMENT_ID');
  </script>
  <!-- 其他内容 -->
</head>

web/index.html文件也需要进行同样的修改。

3. 注意事项

双文件修改：必须同时修改web_src和web目录下的index.html文件，因为web目录是编译后的输出目录，而web_src是源码目录。
GA_MEASUREMENT_ID替换：需要将代码中的"GA_MEASUREMENT_ID"替换为你自己的Google Analytics跟踪ID。
部署后验证：修改完成后，重新部署ShowDoc，并通过Google Analytics实时报告验证代码是否正常工作。

技术原理

这种集成方式利用了Google Analytics的全局站点标签(gtag.js)技术，通过在页面头部插入JavaScript代码，可以实现：

异步加载分析脚本，不影响页面加载速度
自动收集页面浏览量、用户设备等信息
支持后续的事件跟踪和自定义维度配置

扩展建议

除了基本的页面浏览统计外，还可以考虑：

增强型电子商务跟踪：如果ShowDoc用于产品文档，可以跟踪文档中产品链接的点击
自定义事件跟踪：记录用户与文档的交互行为，如搜索、下载等
用户属性分析：区分不同用户群体对文档的使用情况

总结

在ShowDoc项目中集成Google Analytics是一个简单但效果显著的操作，通过修改两个HTML文件即可实现全面的访问统计功能。这对于文档系统的运营和维护具有重要价值，可以帮助团队了解文档使用情况，优化内容结构，提升用户体验。

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具

项目地址：https://gitcode.com/gh_mirrors/sh/showdoc

登录后查看全文

项目优选

收起

OpenHarmony documentation | OpenHarmony开发者文档

flutter_flutter

本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。

deepin linux kernel

🎉 (RuoYi)官方仓库基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统

Cangjie-Examples

本仓将收集和展示高质量的仓颉示例代码，欢迎大家投稿，让全世界看到您的妙趣设计，也让更多人通过您的编码理解和喜爱仓颉语言。

🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端

Ascend Extension for PyTorch

cangjie_compiler

仓颉编译器源码及 cjdb 调试工具。

cangjie_runtime

仓颉编程语言运行时与标准库。