From a6f6ede46a5ce7b2d017ecdfeb2d1c06483c12bd Mon Sep 17 00:00:00 2001 From: fankesyooni Date: Sun, 16 Nov 2025 00:15:36 +0800 Subject: [PATCH] docs: update quick-start --- docs-source/src/en/guide/quick-start.md | 25 ++++++++++++++++++++++ docs-source/src/zh-cn/guide/quick-start.md | 24 +++++++++++++++++++++ 2 files changed, 49 insertions(+) diff --git a/docs-source/src/en/guide/quick-start.md b/docs-source/src/en/guide/quick-start.md index 7cbdd80..82daa90 100644 --- a/docs-source/src/en/guide/quick-start.md +++ b/docs-source/src/en/guide/quick-start.md @@ -443,6 +443,12 @@ android { // - Note: If you disable this option, please make sure that there are no other projects // that also use or not only Gropify to generate code to avoid conflicts. isIsolationEnabled = true + + // Whether to use manifest placeholders' generation. + // + // Disabled by default, when enabled will synchronize the properties' key-values + // to the `manifestPlaceholders` in the `android` configuration method block. + manifestPlaceholders = false } ``` @@ -638,6 +644,7 @@ In Android projects, many repetitive and fixed properties usually need to be con ```properties project.namespace=com.highcapable.gropifydemo +project.appName=Gropify Demo project.compileSdk=36 project.targetSdk=36 project.minSdk=26 @@ -661,6 +668,24 @@ android { } ``` +When you set `manifestPlaceholders = true`, Gropify will automatically synchronize these properties' key-values to `manifestPlaceholders` in the android configuration method block. + +You can then use these placeholders directly in `AndroidManifest.xml`. + +> The following example + +```xml + + + + + ... + + +``` + You no longer need to use `buildConfigField` to add code to `BuildConfig`. With the property key-value code generated by `Gropify`, you can manage your project more flexibly. You can also use interpolation `${...}` in property key-values to reference each other's content, but recursive references are not allowed. diff --git a/docs-source/src/zh-cn/guide/quick-start.md b/docs-source/src/zh-cn/guide/quick-start.md index 72afd11..d3ee68f 100644 --- a/docs-source/src/zh-cn/guide/quick-start.md +++ b/docs-source/src/zh-cn/guide/quick-start.md @@ -418,6 +418,11 @@ android { // - 注意: 如果你禁用此选项,请确保没有其他同样使用或不仅使用 // Gropify 生成代码的项目,以避免冲突 isIsolationEnabled = true + + // 是否使用清单占位符的生成。 + // + // 默认禁用,启用后将同步属性的键值到 `android` 配置方法块中的 `manifestPlaceholders` + manifestPlaceholders = false } ``` @@ -605,6 +610,7 @@ var version = GropifyDemoProperties.PROJECT_VERSION; ```properties project.namespace=com.highcapable.gropifydemo +project.appName=Gropify Demo project.compileSdk=36 project.targetSdk=36 project.minSdk=26 @@ -628,6 +634,24 @@ android { } ``` +当你设置了 `manifestPlaceholders = true` 时,`Gropify` 将自动将这些属性键值同步到 `android` 配置方法块中的 `manifestPlaceholders`。 + +此时你可以直接在 `AndroidManifest.xml` 中使用这些占位符。 + +> 示例如下 + +```xml + + + + + ... + + +``` + 你可以无需再使用 `buildConfigField` 向 `BuildConfig` 添加代码,有了 `Gropify` 生成的属性键值代码,你可以更加灵活地管理你的项目。 你还可以在属性键值中使用插值 `${...}` 互相引用其中的内容,但不允许递归引用。