介绍

使用 Unity Hub 安装时只能安装英文离线文档，需要手动安装中文离线文档。

使用离线文档有很多好处：

  • 文档完全在本地，打开速度快
  • 不用每次手动切换版本，使用的就是当前 Unity 版本对应的文档
  • Rider 也可以使用文档，这样按 F1 可以直接查看对应 API 的文档

下载

中文离线文档的下载地址是 离线文档 - Unity 手册，但是要根据需要切换到对应的 Unity 版本再下载。

不过新版本的中文离线文档链接未更新，可以使用 2020.1 中文离线文档的链接 https://storage.googleapis.com/localized_docs/zh-cn/2020.1/UnityDocumentation.zip，然后将其中的 2020.1 替换成需要的版本号如 2021.3 就可以直接下载。

安装

可以将所有文件解压到 Unity 编辑器安装目录下的 Data/Documentation/en 目录中。如果想要保留原有英文文档可以将 en 目录改名。

提速

Unity 离线文档中嵌入了 Google Analytics 追踪与 OneTrust 隐私设置，会导致卡半天才能打开网页，本地网页应该是秒开才是正常的。另外 OneTrust 还会一直在最下方显示横条，即便点击 接受所有 Cookie 按钮也不会记住，刷新或者打开新页面时依然会显示。

需要删除 Google Analytics、OneTrust 追踪代码以提升打开速度。可以使用全局文本查找替换，只需要将对应的 script 代码删除就可以。由于目录中大概有 20000 个 HTML 文件需要替换，实测 Visual Studio Code 在查找替换时会卡死，这里使用 EmEditor 免费版本来处理，只需要不到 10 秒钟就可以全部替换完成。

流程：搜索 | 在文件中替换，不需要开启正则表达式，过滤 *.html 文件，指定文档所在的目录，勾选 搜索子文件夹 选项，然后将多行文本直接粘贴到查找文本框中。

具体要删除掉的代码是：

Google Analytics

1
2
3
4
5
6

    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
      new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
      j=d.createElement(s),dl=l!='dataLayer'?'&amp;l='+l:'';j.async=true;j.src=
      '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
      })(window,document,'script','dataLayer','GTM-5V25JL6');
    </script>

1
2
3
4

    <noscript>
      <iframe src="//www.googletagmanager.com/ns.html?id=GTM-5V25JL6" height="0" width="0" style="display:none;visibility:hidden">
      </iframe>
    </noscript>

OneTrust

1
2
3
4
5

    <script type="text/javascript" src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" charset="UTF-8" data-domain-script="6e91be4c-3145-4ea2-aa64-89d716064836">
    </script>
    <script type="text/javascript">
        function OptanonWrapper() { }
    </script>

上面只是列出样例，实际替换时建议直接使用原始 HTML 中的代码，可能不同版本的文档内部追踪代码不同。