返回

React 环境变量自动更新:突破缓存顽疾,畅享 Gitbook 即时更新

前端

前言

Gitbook 作为备受欢迎的在线文档工具,凭借其友好清晰的排版和易于访问的平台,受到众多开发者的青睐。然而,当你在使用 Gitbook 访问你的在线文档时,可能会遇到一种烦人的问题:缓存的頑固不化。

Gitbook CDN 上的缓存往往非常持久,即使你已经更新了你的文档内容,访问者在访问你的文档时,看到的仍然是旧版本的内容。这种情况尤其令人恼火,尤其是当你在分享重要信息或更新时。

为了解决这一问题,我们可以借助 React 代码中的自动更新 CRA 环境变量,为你的 Gitbook文档添加一个清缓存参数,从而确保访问者始终可以看到最新版本的内容。

一、在 React 代码中配置 CRA 环境变量

首先,你需要在你的 React 代码中配置 CRA 环境变量。CRA(Create React App)是 Facebook 开源的创建 React 应用的工具,它提供了一系列开箱即用的配置,包括环境变量的支持。

在你的项目中,创建一个名为 .env.development 或 .env.production 的文件(取决于你正在运行的是开发环境还是生产环境),并在该文件中添加如下内容:

REACT_APP_GITBOOK_VERSION=1.0.0

注意,REACT_APP_GITBOOK_VERSION 是一个自定义的环境变量,你可以根据自己的需要命名。1.0.0 是一个示例版本号,你可以将其替换为你的实际版本号。

二、在 Gitbook URL 中添加清缓存参数

接下来,你需要在你的 Gitbook URL 中添加一个清缓存参数。具体而言,你需要在 Gitbook URL 后面添加 ?v=REACT_APP_GITBOOK_VERSION,其中 REACT_APP_GITBOOK_VERSION 是你在上一步中配置的环境变量。

例如,如果你想访问你的 Gitbook 文档的最新版本,你的 URL 可能会是这样的:

https://your-gitbook.com?v=1.0.0

三、如何确保每次更新后版本号自动增加

为了确保每次更新后版本号都会自动增加,你可以使用一些自动化工具,如 Git 钩子或 CI/CD 管道。例如,你可以在每次代码推送到远程仓库时,自动触发一个脚本,将版本号增加 1,并更新 .env.development 或 .env.production 文件中的 REACT_APP_GITBOOK_VERSION 值。

总结

通过在 React 代码中配置 CRA 环境变量并将其添加到你的 Gitbook URL 中,你可以轻松地为你的 Gitbook 文档添加一个清缓存参数,从而确保访问者始终可以看到最新版本的内容。这种方法简单易行,并且可以与任何 Gitbook 文档配合使用。