From 6477c9f27a4e9525082400c17e93d7d91605271c Mon Sep 17 00:00:00 2001 From: fankesyooni Date: Sun, 3 Aug 2025 01:56:05 +0800 Subject: [PATCH] docs(fix): normalized --- docs-source/src/en/about/changelog.md | 2 +- docs-source/src/en/about/contacts.md | 2 +- docs-source/src/en/about/future.md | 8 ++++---- docs-source/src/en/config/r8-proguard.md | 12 ++++++------ docs-source/src/en/guide/home.md | 14 +++++++------- docs-source/src/en/guide/quick-start.md | 14 +++++++------- docs-source/src/en/index.md | 4 ++-- docs-source/src/en/library/hikage-compiler.md | 10 +++++----- docs-source/src/en/library/hikage-core.md | 8 ++++---- .../en/library/hikage-extension-betterandroid.md | 6 +++--- .../src/en/library/hikage-extension-compose.md | 6 +++--- docs-source/src/en/library/hikage-extension.md | 6 +++--- .../src/en/library/hikage-widget-androidx.md | 6 +++--- .../src/en/library/hikage-widget-material.md | 6 +++--- 14 files changed, 52 insertions(+), 52 deletions(-) diff --git a/docs-source/src/en/about/changelog.md b/docs-source/src/en/about/changelog.md index a3c8e0d..09643ae 100644 --- a/docs-source/src/en/about/changelog.md +++ b/docs-source/src/en/about/changelog.md @@ -4,7 +4,7 @@ ::: danger -We will only maintain the latest API version, if you are using an outdate API version, you voluntarily renounce any possibility of maintenance. +We will only maintain the latest dependencies. If you are using outdated dependencies, you voluntarily renounce any possibility of maintenance. ::: diff --git a/docs-source/src/en/about/contacts.md b/docs-source/src/en/about/contacts.md index f07866a..dfa9dd5 100644 --- a/docs-source/src/en/about/contacts.md +++ b/docs-source/src/en/about/contacts.md @@ -1,6 +1,6 @@ # Contact Us -> If you have any questions in use, or have any constructive suggestions, you can contact us. +> If you have any questions during usage, or have any constructive suggestions, you can contact us. Join our developers group. diff --git a/docs-source/src/en/about/future.md b/docs-source/src/en/about/future.md index 184a121..32d7b42 100644 --- a/docs-source/src/en/about/future.md +++ b/docs-source/src/en/about/future.md @@ -1,4 +1,4 @@ -# Looking for Future +# Looking Toward the Future > The future is bright and uncertain, let us look forward to the future development space of `Hikage`. @@ -6,13 +6,13 @@ > Features that `Hikage` may add later are included here. -### Process AttrtibuteSet +### Process AttributeSet -`Hikage` will support processing `AttributeSet` in the future to dock with the original XML properties to implement the takeover +`Hikage` will support processing `AttributeSet` in the future to interface with the original XML properties to implement the takeover of some third-party components that are not open to customization of layout properties in the code. `Hikage` currently supports automated creation of `XmlBlock`, but does not support the direct processing -of customized `AttributeSet`. Because of its historical problems and high processing difficulty, it may compromise whether to continue to improve this function in the later stage. +of customized `AttributeSet`. Because of its historical problems and high processing difficulty, it may be considered whether to continue to improve this function in later stages. > The following example diff --git a/docs-source/src/en/config/r8-proguard.md b/docs-source/src/en/config/r8-proguard.md index 1e07c72..d8fb0ef 100644 --- a/docs-source/src/en/config/r8-proguard.md +++ b/docs-source/src/en/config/r8-proguard.md @@ -1,17 +1,17 @@ -# R8 & Proguard Obfuscate +# R8 & Proguard Obfuscation -> In most scenarios, the app packages can be compressed through obfuscation, -> here is an introduction to how to configure obfuscation rules. +> In most scenarios, app packages can be compressed through obfuscation. +> Here is an introduction to how to configure obfuscation rules. -`Hikage` does not require additional configuration of obfuscation rules, since `View` loaded by Hikage does not need to be defined in XML, they can be equally obfuscated. +`Hikage` does not require additional configuration of obfuscation rules, since `View` objects loaded by Hikage do not need to be defined in XML, they can be equally obfuscated. -You can force them to be confused with your custom `View`, such as `com.yourpackage.YourView`, using the following rules. +You can force them to be obfuscated with your custom `View`, such as `com.yourpackage.YourView`, using the following rules. ``` -allowobfuscation class com.yourpackage.YourView ``` -If you must prevent `Hikage` from being confused or something that occurs after being confused, you can use the following rules to prevent `Hikage` from being confused. +If you must prevent `Hikage` from being obfuscated or if something occurs after being obfuscated, you can use the following rules to prevent `Hikage` from being obfuscated. ``` -keep class com.highcapable.hikage** diff --git a/docs-source/src/en/guide/home.md b/docs-source/src/en/guide/home.md index 1741955..4cd7335 100644 --- a/docs-source/src/en/guide/home.md +++ b/docs-source/src/en/guide/home.md @@ -1,10 +1,10 @@ -# Introduce +# Introduction > `Hikage` (Pronunciation /ˈhɪkɑːɡeɪ/) is an Android responsive UI building tool. ## Background -This is an Android responsive UI build tool designed to focus on **Real-time code building UI**. +This is an Android responsive UI build tool designed to focus on **real-time code-based UI building**. The project icon was designed by [MaiTungTM](https://github.com/Lagrio), the name is taken from the original song "Haru**hikage**" in "BanG Dream It's MyGO!!!!!". @@ -22,11 +22,11 @@ and its design goal is to enable developers to quickly build UIs and directly su **Hikage is just a UI build tool and does not provide any UI components themselves**. -Rejecting duplicate wheels, our solution is always compatible and efficient. Now you can abandon ViewBinding and XML and even `findViewById` and try -to use the code layout directly. +Rejecting duplicate wheels, our solution is always compatible and efficient. Now you can abandon ViewBinding and XML, and even `findViewById`, and try +using code layout directly. -`Hikage` works better with another project [BetterAndroid](https://github.com/BetterAndroid/BetterAndroid) and -`Hikage` itself will automatically reference the `BetterAndroid` related dependencies as the core content. +`Hikage` works better with another project [BetterAndroid](https://github.com/BetterAndroid/BetterAndroid), and +`Hikage` itself will automatically reference the `BetterAndroid`-related dependencies as the core content. ## Usage @@ -116,5 +116,5 @@ The maintenance of this project is inseparable from the support and contribution This project is currently in its early stages, and there may still be some problems or lack of functions you need. -If possible, feel free to submit a PR to contribute features you think are needed to this project or goto [GitHub Issues](repo://issues) +If possible, feel free to submit a PR to contribute features you think are needed to this project, or go to [GitHub Issues](repo://issues) to make suggestions to us. \ No newline at end of file diff --git a/docs-source/src/en/guide/quick-start.md b/docs-source/src/en/guide/quick-start.md index 2bfb557..415163e 100644 --- a/docs-source/src/en/guide/quick-start.md +++ b/docs-source/src/en/guide/quick-start.md @@ -4,12 +4,12 @@ ## Project Requirements -The project needs to be created using `Android Studio` or `IntelliJ IDEA` and be of type Android or Kotlin Multiplatform -project and have integrated Kotlin environment dependencies. +The project needs to be created using `Android Studio` or `IntelliJ IDEA` and must be an Android or Kotlin Multiplatform +project with integrated Kotlin environment dependencies. -- Android Studio (It is recommended to get the latest version [from here](https://developer.android.com/studio)) +- Android Studio (It is recommended to get the latest version from [here](https://developer.android.com/studio)) -- IntelliJ IDEA (It is recommended to get the latest version [from here](https://www.jetbrains.com/idea)) +- IntelliJ IDEA (It is recommended to get the latest version from [here](https://www.jetbrains.com/idea)) - Kotlin 1.9.0+, Gradle 8+, Java 17+, Android Gradle Plugin 8+ @@ -38,7 +38,7 @@ repositories: #### Traditional Method -Configure repositories in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin repositories { @@ -53,7 +53,7 @@ repositories { ### Configure Java Version -Modify the Java version of Kotlin in your project `build.gradle.kts` to 17 or above. +Modify the Java version of Kotlin in your project's `build.gradle.kts` to 17 or above. > Kotlin DSL @@ -85,5 +85,5 @@ Click the corresponding module below to view detailed feature descriptions. ## Demo -You can find some samples [here](repo://tree/main/samples) view the corresponding demo project to better understand how these functions work and quickly +You can find some samples [here](repo://tree/main/samples) to view the corresponding demo project to better understand how these functions work and quickly select the functions you need. \ No newline at end of file diff --git a/docs-source/src/en/index.md b/docs-source/src/en/index.md index d1c7d8a..c1e1a01 100644 --- a/docs-source/src/en/index.md +++ b/docs-source/src/en/index.md @@ -14,8 +14,8 @@ features: details: Using View as the foundation and Kotlin as the development language, 100% dynamic code layout, no additional configuration required, supports custom Views. - title: Fully Compatible details: Supports embedding and mixing XML, ViewBinding, and Jetpack Compose, and provides support for Material components and Jetpack. - - title: Quickly Started - details: Simple and easy to use it now! Do not need complex configuration and full development experience, Integrate dependencies and enjoy yourself. + - title: Quick to Start + details: Simple and easy to use right now! No complex configuration or extensive development experience needed. Just integrate dependencies and enjoy! footer: Apache-2.0 License | Copyright (C) 2019 HighCapable --- diff --git a/docs-source/src/en/library/hikage-compiler.md b/docs-source/src/en/library/hikage-compiler.md index 2df7db4..6c17c13 100644 --- a/docs-source/src/en/library/hikage-compiler.md +++ b/docs-source/src/en/library/hikage-compiler.md @@ -33,7 +33,7 @@ libraries: version: + ``` -Configure dependency in your root project `build.gradle.kts`. +Configure dependency in your root project's `build.gradle.kts`. ```kotlin plugins { @@ -42,7 +42,7 @@ plugins { } ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin plugins { @@ -72,7 +72,7 @@ ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" } hikage-compiler = { module = "com.highcapable.hikage:hikage-compiler", version.ref = "hikage-compiler" } ``` -Configure dependency in your root project `build.gradle.kts`. +Configure dependency in your root project's `build.gradle.kts`. ```kotlin plugins { @@ -81,7 +81,7 @@ plugins { } ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin plugins { @@ -109,7 +109,7 @@ plugins { } ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin plugins { diff --git a/docs-source/src/en/library/hikage-core.md b/docs-source/src/en/library/hikage-core.md index a976faf..4681bc9 100644 --- a/docs-source/src/en/library/hikage-core.md +++ b/docs-source/src/en/library/hikage-core.md @@ -23,7 +23,7 @@ libraries: version: + ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(com.highcapable.hikage.hikage.core) @@ -41,7 +41,7 @@ hikage-core = "" hikage-core = { module = "com.highcapable.hikage:hikage-core", version.ref = "hikage-core" } ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(libs.hikage.core) @@ -51,7 +51,7 @@ Please change `` to the version displayed at the top of this document. ### Traditional Method -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation("com.highcapable.hikage:hikage-core:") @@ -96,7 +96,7 @@ val root = hikage.root activity.setContentView(root) ``` -In this way, we complete a simple layout creation and setting. +In this way, we can complete a simple layout creation and configuration. ### Layout Agreement diff --git a/docs-source/src/en/library/hikage-extension-betterandroid.md b/docs-source/src/en/library/hikage-extension-betterandroid.md index 1aacdda..b987b54 100644 --- a/docs-source/src/en/library/hikage-extension-betterandroid.md +++ b/docs-source/src/en/library/hikage-extension-betterandroid.md @@ -23,7 +23,7 @@ libraries: version: + ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(com.highcapable.hikage.hikage.extension.betterandroid) @@ -41,7 +41,7 @@ hikage-extension-betterandroid = "" hikage-extension-betterandroid = { module = "com.highcapable.hikage:hikage-extension-betterandroid", version.ref = "hikage-extension-betterandroid" } ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(libs.hikage.extension.betterandroid) @@ -51,7 +51,7 @@ Please change `` to the version displayed at the top of this document. ### Traditional Method -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation("com.highcapable.hikage:hikage-extension-betterandroid:") diff --git a/docs-source/src/en/library/hikage-extension-compose.md b/docs-source/src/en/library/hikage-extension-compose.md index d6469f0..fd99a7d 100644 --- a/docs-source/src/en/library/hikage-extension-compose.md +++ b/docs-source/src/en/library/hikage-extension-compose.md @@ -31,7 +31,7 @@ libraries: version: + ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(com.highcapable.hikage.hikage.extension.compose) @@ -49,7 +49,7 @@ hikage-extension-compose = "" hikage-extension-compose = { module = "com.highcapable.hikage:hikage-extension-compose", version.ref = "hikage-extension-compose" } ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(libs.hikage.extension.compose) @@ -59,7 +59,7 @@ Please change `` to the version displayed at the top of this document. ### Traditional Method -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation("com.highcapable.hikage:hikage-extension-compose:") diff --git a/docs-source/src/en/library/hikage-extension.md b/docs-source/src/en/library/hikage-extension.md index 9392a88..feb8f58 100644 --- a/docs-source/src/en/library/hikage-extension.md +++ b/docs-source/src/en/library/hikage-extension.md @@ -23,7 +23,7 @@ libraries: version: + ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(com.highcapable.hikage.hikage.extension) @@ -41,7 +41,7 @@ hikage-extension = "" hikage-extension = { module = "com.highcapable.hikage:hikage-extension", version.ref = "hikage-extension" } ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(libs.hikage.extension) @@ -51,7 +51,7 @@ Please change `` to the version displayed at the top of this document. ### Traditional Method -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation("com.highcapable.hikage:hikage-extension:") diff --git a/docs-source/src/en/library/hikage-widget-androidx.md b/docs-source/src/en/library/hikage-widget-androidx.md index 5daa545..ab3e124 100644 --- a/docs-source/src/en/library/hikage-widget-androidx.md +++ b/docs-source/src/en/library/hikage-widget-androidx.md @@ -23,7 +23,7 @@ libraries: version: + ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(com.highcapable.hikage.hikage.widget.androidx) @@ -41,7 +41,7 @@ hikage-widget-androidx = "" hikage-widget-androidx = { module = "com.highcapable.hikage:hikage-widget-androidx", version.ref = "hikage-widget-androidx" } ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(libs.hikage.widget.androidx) @@ -51,7 +51,7 @@ Please change `` to the version displayed at the top of this document. ### Traditional Method -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation("com.highcapable.hikage:hikage-widget-androidx:") diff --git a/docs-source/src/en/library/hikage-widget-material.md b/docs-source/src/en/library/hikage-widget-material.md index 93e63d4..fef8b7c 100644 --- a/docs-source/src/en/library/hikage-widget-material.md +++ b/docs-source/src/en/library/hikage-widget-material.md @@ -23,7 +23,7 @@ libraries: version: + ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(com.highcapable.hikage.hikage.widget.material) @@ -41,7 +41,7 @@ hikage-widget-material = "" hikage-widget-material = { module = "com.highcapable.hikage:hikage-widget-material", version.ref = "hikage-widget-material" } ``` -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation(libs.hikage.widget.material) @@ -51,7 +51,7 @@ Please change `` to the version displayed at the top of this document. ### Traditional Method -Configure dependency in your project `build.gradle.kts`. +Configure dependency in your project's `build.gradle.kts`. ```kotlin implementation("com.highcapable.hikage:hikage-widget-material:")