docs: format anchor link (#124)

qwd · Feb 23, 2024 · 601e9c4 · 601e9c4
1 parent f540834
commit 601e9c4
Show file tree

Hide file tree

Showing 29 changed files with 145 additions and 147 deletions.
diff --git a/docs/_en/configuration/ios-sdk-config.md b/docs/_en/configuration/ios-sdk-config.md
@@ -21,7 +21,7 @@ Make sure you have created a Project and iOS SDK KEY, otherwise refer to [Projec
 
 iOS SDK supports the following installation methods:
 
-### Use CocoaPods
+### CocoaPods
 
 QWeather iOS SDK can be installed via [CocoaPods](https://cocoapods.org/). CocoaPods is an open source dependency manager, if you haven't installed CocoaPods yet, please refer to [CocoaPods Getting Started guide](https://guides.cocoapods.org/using/getting-started.html). The following steps assume that you have already completed the installation and setup of CocoaPods.
 

diff --git a/docs/_zh/account/developers.md b/docs/_zh/account/developers.md
@@ -17,7 +17,7 @@ ref: account-developers
 |增值税发票|增值税电子普通发票|增值税电子普通发票|增值税专用发票<br />增值税电子普通发票|
 |技术支持|工单|工单|工单、电子邮件|
 
-## 注册开发者
+## 注册开发者 {#enroll-certified-developer}
 
 注册开发者需要对你的帐号进行实名认证，访问[控制台-设置-用户信息](https://console-test.qweather.com/#/user/space)，在上方点击注册开发者。
 
@@ -52,7 +52,7 @@ ref: account-developers
 
 最后点击“提交审核”按钮，进入审核流程。审核通过后，你的企业开发者信息将完成变更。
 
-## 取消开发者注册
+## 取消开发者注册 {#cancel-certified-developer}
 
 一旦注册为开发者后，你无法主动取消。如果你不再使用和风天气开发服务，你可以删除你的帐号。
 

diff --git a/docs/_zh/account/inactive.md b/docs/_zh/account/inactive.md
@@ -8,22 +8,22 @@ ref: account-inactive
 
 因此，当用户长期未使用和风天气的产品时，我们将该用户帐号标记为“**闲置帐号**” ，所有**闲置帐号**将被从和风天气开发服务删除。
 
-## 什么是闲置
+## 什么是闲置 {#what-is-inactive}
 
 **闲置**指的是用户连续12个月：
 
 - 未登录过[开发控制台](https://console.qweather.com)
 - 未使用任何和风天气开发服务，包括创建了开发项目但是未发送任何请求
 
-## 闲置的后续情况
+## 闲置的后续情况 {#what-happens-when-your-account-is-inactive}
 
 当用户满足上述闲置条件后，该帐号将被标记为**闲置帐号**，在此之前，和风天气会通过用户的注册电子邮件发送提醒通知。
 
 和风天气会将**闲置帐号**从和风天气开发服务删除，删除后你在和风天气开发服务中的所有内容（包括项目、订单、统计记录、开发者身份信息、偏好设置等）将一并删除。
 
 用户可以重新注册和风天气开发服务，但之前被删除的任何信息都将无法恢复。
 
-## 例外
+## 例外 {#exception}
 
 如果用户的帐号符合下列一项或多项条件，即使用户的帐号满足了上述闲置的条件，也不会被视为闲置：
 

diff --git a/docs/_zh/account/recipients.md b/docs/_zh/account/recipients.md
@@ -6,15 +6,15 @@ ref: account-contact
 
 你可以为你的帐号添加多个通知接收人，这些接收人可以收到你帐号的所有通知。例如，你是帐号所有者，你希望在你的企业内其他人也能收到账单或服务到期提醒，这时你可以将他们添加到你的通知接收人中。
 
-## 添加通知接收人
+## 添加通知接收人 {#add-recipients}
 
 访问[控制台-设置-通知](https://console.qweather.com/#/user/notice)，在下方可以看到你当前的所有通知接收人。如需要添加新的通知接收人，你只需要填写他的电子邮箱地址并点击“邀请”按钮。
 
 被邀请人将收到一封邀请邮件，需要通过点击邮件中的激活链接表示同意邀请。当接收人同意邀请后，他就可以收到你的帐号内所设置的所有通知。
 
 如果被邀请人没有点击激活链接，或未收到邀请邮件，你可以稍等60分钟后重新发送。请注意，邀请邮件的有效期为24小时，如果超过24小时，邀请链接将失效。如果收到多封邀请邮件，以最新的一封邮件为准。
 
-## 删除通知接收人
+## 删除通知接收人 {#remove-recipients}
 
 你可以从[控制台-设置-通知](https://console.qweather.com/#/user/notice)删除通知接收人，在需要删除的电子邮箱旁点击“删除”按钮即可。
 
@@ -23,6 +23,4 @@ ref: account-contact
 ## 限制 {#restriction}
 
 - 你最多可以添加5个通知联系人。
-- 所有涉及到帐号安全的通知不会发送给通知接收人，例如找回密码等。
-
-
+- 所有涉及到帐号安全的通知不会发送给通知接收人，例如找回密码等。
diff --git a/docs/_zh/account/suspension.md b/docs/_zh/account/suspension.md
@@ -6,14 +6,14 @@ ref: account-suspension
 
 当你的行为违反了和风天气的[各项条款](/docs/terms/)，你的帐号可能将被冻结，冻结后你将无法操作你帐号中的大部分功能，并且和风天气保留对你的违规行为要求赔偿的权利，严重时你将面临法律风险。
 
-## 后果
+## 后果 {#consequences}
 
 - 冻结帐号无法使用和风天气所有开发服务，包括之前创建的项目，所有开发请求都将被拒绝。
 - 冻结帐号内如有未到期订阅或未使用的可用额度，都将暂时无法使用。
 - 控制台中的所有功能将无法使用，如因为欠款账单而造成的冻结，则除充值以外的功能无法使用。
 - 已绑定的支付方式可能无法在其他正常帐号中使用。
 
-## 为什么冻结帐号
+## 为什么冻结帐号 {#why-accounts-are-suspended}
 
 和风天气开发者服务的各项条款有助于全体用户获得公平服务，并保护用户与和风天气合作伙伴的权益，因此如果你的行为违反了这些条款，你的帐号可能会被冻结。
 
@@ -35,7 +35,7 @@ ref: account-suspension
 
    在你提供给和风天气的帐号信息中存在虚假内容，例如错误的电子邮箱、身份信息等，在这种情况下我们会暂停你的帐号。请注意，虚假信息包含临时邮箱或临时电话号码。
 
-## 恢复和申诉
+## 恢复和申诉 {#restore-and-appeal}
 
 对于因欠款账单而冻结的帐号，你可以登录控制台完成欠款账单的支付，即可恢复和风天气的服务。
 

diff --git a/docs/_zh/best-practices/cache.md b/docs/_zh/best-practices/cache.md
@@ -55,7 +55,7 @@ ref: bp-cache
 | 台风             | 活跃期 20分钟<br />非活跃期60分钟 | 10-60分钟          |
 | 太阳辐照         | 6小时                             | 3-6小时            |
 
-## 限制
+## 限制 {#restrictions}
 
 你不能缓存、提取、批量存储GeoAPI中提供的所有数据，这将违反我们的[使用限制](/docs/terms/restriction/)和[服务条款](https://www.qweather.com/terms/developers-tos)。
 

diff --git a/docs/_zh/best-practices/protect-data-key.md b/docs/_zh/best-practices/protect-data-key.md
@@ -10,26 +10,26 @@ KEY是获取和风天气数据的重要敏感信息，你有责任妥善保管
 
 从2014年开始，我们的API就支持了HTTPS加密访问，在2016年底，我们关闭了所有非HTTPS的访问。使用HTTPS可以有效的阻止请求中的敏感信息被泄露，请不要跳过HTTPS的保护。
 
-## 使用加密签名认证
+## 使用加密签名认证 {#signature-authentication}
 
 使用[加密签名](/docs/resource/signature-auth/)的方式进行认证，这样即使他人抓取到了你的请求信息，也很难获得更多有价值的内容。
 
-## 为每个产品创建不同的KEY
+## 为每个产品创建不同的KEY {#create-separate-key-for-each-product}
 
 我们支持创建多个KEY和项目，因此不要把鸡蛋都放在一个篮子里，对于不同的产品或者同一产品的不同平台，应该创建不同KEY进行使用，例如你要做一个款关于旅游的项目，可以为iOS、Android、小程序和网站创建不同的KEY。
 
-## 更改KEY
+## 更改KEY {#change-key}
 
 如果你认为你的KEY已经泄露或者怀疑泄露，你可以新建一个KEY，然后升级你的程序，测试并确保程序都运行在新的KEY，最后删除旧的KEY。
 
-## 在服务端保存KEY
+## 在服务端保存KEY {#store-key-on-the-server-side}
 
 在服务端存储KEY，再通过服务端发送到前端需要展示的天气数据，这样他人就无法在前端中抓取到你的KEY。
 
-## 混淆或加密KEY
+## 混淆或加密KEY {#encrypt-key}
 
 如果不可避免的在前端中存储KEY，那么也可以通过混淆或加密代码的方式，再配合不定期的更改KEY，从而让他人获取这些数据更加困难。
 
-## 不要在代码中共享
+## 不要在代码中共享 {#do-not-share-with-others}
 
 在开发过程中，不可避免的会与其他人共享你的代码，因此将KEY存储在环境变量或独立的文件中，则可以有效的避免代码共享时泄露你的KEY。如果你的代码会发布在公共源代码管理系统时（例如Github），请确保存储KEY的文件包含在`.gitignore`或其他类似功能的配置文件中，换句话说，让KEY不要保留在源代码管理系统中。
diff --git a/docs/_zh/configuration/android-sdk-config.md b/docs/_zh/configuration/android-sdk-config.md
@@ -6,21 +6,21 @@ ref: config-android
 
 这篇文档将介绍如何配置和风天气开发服务中的Android SDK。
 
-## 下载 
+## 下载 {#download}
 
 |版本|日期|MD5|下载|
 |---|---|---|---|
 |{{ site.data.v.android.version }}|{{ site.data.v.android.date }}|{{ site.data.v.android.md5 }}|[下载]({{ site.data.v.android.dllink }})|
 
-## 创建项目和KEY
+## 创建项目和KEY {#create-project-and-key}
 
 请确保你已经创建了一个Android SDK的KEY，否则请参考[项目和KEY](/docs/configuration/project-and-key/)。
 
-## 适配版本
+## 适配版本 {#os-requirement}
 
 Android 4.4+
 
-## 工程配置
+## 工程配置 {#project-configuration}
 
 1. 解压文件，将文件夹内jar放入您的工程，并且引用
 2. 配置Android Manifest 添加权限
@@ -58,7 +58,7 @@ Android 4.4+
  -keep class com.qweather.sdk.** { *;}
 ```
 
-## 数据访问配置
+## 数据访问配置 {#data-access-configuration}
 
 **日志功能**
 

diff --git a/docs/_zh/configuration/api-config.md b/docs/_zh/configuration/api-config.md
@@ -6,11 +6,11 @@ ref: config-api
 
 在开始使用和风天气API服务之前，你需要进行一些简单的配置和准备工作。
 
-## 创建项目和KEY
+## 创建项目和KEY {#create-project-and-key}
 
 请确保已经创建了项目和Web API KEY，否则请参考[项目和KEY](/docs/configuration/project-and-key/)。
 
-## 了解API地址和参数
+## 了解API地址和参数 {#understanding-api-url}
 
 通常来讲，一个完整的API请求URL由scheme，host，port，path和query parameters组成。（当然，在不同程序中可能叫法不一样，我们仅以[RFC 3986](https://www.rfc-editor.org/rfc/rfc3986)为参考）
 
@@ -33,11 +33,11 @@ scheme        host   (port)   path        query parameters
 
 对于大部分开发者来说，构建一个API URL并非难事，但我们仍然强烈建议你阅读[最佳实践-优化请求](/docs/best-practices/optimize-requests/)文档，了解发送API请求的一些常见问题和经验。
 
-## Gzip解压
+## Gzip
 
 请注意，和风天气开发服务的API均使用Gzip进行了压缩，这将极大的减少网络流量，加快请求。因此，当你在开发过程中，需要对返回的数据进行解压。请参考[最佳实践-Gzip](/docs/best-practices/gzip/)。
 
-## 尝试一下
+## 尝试一下 {#try-it-out}
 
 请复制并粘贴下列链接到你的浏览器中，看看返回了哪些内容。注意链接最后的参数`key`要换成你自己的KEY。
 

diff --git a/docs/_zh/configuration/ios-sdk-config.md b/docs/_zh/configuration/ios-sdk-config.md
@@ -14,15 +14,15 @@ ref: config-ios
 
 > **提示：**和风天气iOS SDK同样包含了macOS SDK。
 
-## 第1步: 创建项目和KEY
+## 第1步: 创建项目和KEY {#step-1-create-project-and-key}
 
 请确保你已经创建了一个iOS SDK的KEY，否则请参考[项目和KEY](/docs/configuration/project-and-key/)。
 
-## 第2步: 安装SDK
+## 第2步: 安装SDK {#step-2-install-sdk}
 
 和风天气iOS SDK支持下列安装方式：
 
-### 使用CocoaPods
+### CocoaPods {#cocoapods}
 
 和风天气iOS SDK可以通过[CocoaPods](https://cocoapods.org/)进行安装。CocoaPods是一种开源依赖库管理器，如果你还未安装CocoaPods，请参考[CocoaPods快速开始](https://guides.cocoapods.org/using/getting-started.html)。下列步骤假设你已经完成了CocoaPods的安装和设置。
 
@@ -62,7 +62,7 @@ iOS SDK支持使用Swift Package Manager集成，具体步骤请参考[Adding pa
 * SDK URL: [https://github.com/qwd/iOS-SDK.git](https://github.com/qwd/iOS-SDK.git)
 * Dependency Rule: Up to Next Major Version 4.14.0 < 5.0.0
 
-### 手动安装
+### 手动安装 {#manual-install}
 
 你可以选择手动安装和风天气iOS SDK。
 
@@ -93,11 +93,11 @@ iOS SDK支持使用Swift Package Manager集成，具体步骤请参考[Adding pa
 >    ```
 {:.bqwarning}
 
-## 第3步: 配置密钥和订阅版本
+## 第3步: 配置密钥和订阅版本 {#step-3-setup-key-and-subscription}
 
 在 `AppDelegate`文件中配置API密钥信息和选择订阅版本:
 
-### 配置Public ID和KEY
+### 配置Public ID和KEY {#setup-public-id-and-key}
 
 将代码中的`Your_KEY`和`Your_Public_ID`替换为你项目中的KEY和Public ID
 
@@ -106,7 +106,7 @@ QWeatherConfigInstance.publicID = @"Your_Public_ID";
 QWeatherConfigInstance.appKey = @"Your_KEY";
 ```
 
-### 配置项目的订阅版本
+### 配置项目的订阅版本 {#setup-subscription}
 
 - 标准订阅：
 
@@ -119,7 +119,7 @@ QWeatherConfigInstance.appKey = @"Your_KEY";
     QWeatherConfigInstance.appType = APP_TYPE_DEV;
     ```
 
-## 示例代码
+## 示例代码 {#sample-code}
 
 在需要使用的地方加入以下代码输入所需参数即可，返回为对应类型的数据模型
 

diff --git a/docs/_zh/configuration/project-and-key.md b/docs/_zh/configuration/project-and-key.md
@@ -9,7 +9,7 @@ ref: config-project
 
 **KEY**是获取和风天气开发服务的密钥（或称之为token，认证信息），在创建项目后，你可以为你的不同业务和需求创建KEY，例如“iOS正式环境”或“测试专用”。
 
-## 创建项目
+## 创建项目 {#create-project}
 
 1. 访问[控制台-项目管理](https://console.qweather.com/#/apps)，点击“创建项目”按钮。
 2. 填写项目名称，项目名称最多20个字符。你可以稍后对名称进行修改。
@@ -18,7 +18,7 @@ ref: config-project
 5. 填写KEY的名称，最多20个字符。
 6. 点击“创建”按钮。
 
-## 创建KEY
+## 创建KEY {#create-key}
 
 当你创建一个项目的时候，已经要求创建一个KEY，如果需要创建更多的KEY：
 
@@ -31,13 +31,13 @@ ref: config-project
 4. 填写KEY的名称，最多20个字符。你可以稍后对名称进行修改。
 5. 点击“创建”按钮。
 
-## 编辑项目和KEY
+## 编辑项目和KEY {#edit-project-and-key}
 
 你可以对项目和KEY的名称进行编辑，编辑名称不会影响你的开发服务，实时生效。
 
 你也可以对iOS KEY的Bundle ID或Android KEY的Package Name进行编辑，可能需要一些时间才可生效，最长4小时，生效后原来绑定的Bundle ID或Package Name将无法再获取到数据。
 
-## 删除项目
+## 删除项目 {#delete-project}
 
 > **警告：**删除动作不可撤销，删除成功后，该项目及项目中的所有数据KEY都将被删除且无法恢复，你无法再通过这个项目中的KEY获取数据。
 {:.bqdanger}
@@ -46,7 +46,7 @@ ref: config-project
 2. 点击“删除”按钮。
 3. 在打开的确认窗口中再次确认是否删除，如果不希望删除，点击“取消”按钮，如果确定删除，请输入项目名称并点击“确认删除”按钮。
 
-## 删除KEY
+## 删除KEY {#delete-key}
 
 > **警告：**删除动作不可撤销，删除成功后，你无法再通过这个KEY获取数据。
 {:.bqdanger}

diff --git a/docs/_zh/features/global-deployment.md b/docs/_zh/features/global-deployment.md
@@ -8,25 +8,25 @@ ref: feat-global
 
 使用全球部署能力不需要你进行额外的配置，这一切几乎都是自动化的。
 
-## 多语言
+## 多语言 {#multi-language}
 
 和风天气开发服务支持30+语言和本地语言，你只需要简单的在请求中添加多语言参数即可。
 
 查看[我们支持的语言](/docs/resource/language/)。
 
-## 单位转换
+## 单位转换 {#unit-conversion}
 
 和风天气开发服务提供公制单位和英制单位的选项，对于不同国家和地区的用户，你可以为他们设置合适的单位。
 
 查看[单位](/docs/resource/unit/)。
 
-## 全球城市覆盖
+## 全球城市覆盖 {#global-city-coverage}
 
 目前我们已经为全球超过20万个城市或地区提供气象服务，使用我们的地理信息服务，可以轻松的获取这些城市的信息。
 
 查看[地理信息服务](/docs/api/geoapi/)。
 
-## 全球加速
+## 全球加速 {#global-acceleration}
 
 ![global-server](/assets/images/content/global-server-flow.png)
 

diff --git a/docs/_zh/features/performance.md b/docs/_zh/features/performance.md
@@ -6,7 +6,7 @@ ref: feat-performance
 
 和风天气开发服务提供了稳定和高性能的服务保障，这使得你的开发没有后顾之忧。
 
-## 性能
+## 性能 {#performance}
 
 和风天气开发服务可提供企业级性能的服务：