BetterAndroid/Hikage
5
0
Fork 0
mirror of https://github.com/BetterAndroid/Hikage.git synced 2025-09-05 10:15:37 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(fix): normalized

Browse Source
This commit is contained in:
fankesyooni
2025-08-03 01:56:05 +08:00
parent a2eb724df5
commit 6477c9f27a
14 changed files with 52 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs-source/src/en/about/changelog.md
View File

@@ -4,7 +4,7 @@
::: danger ::: 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.
::: :::

2
docs-source/src/en/about/contacts.md
View File

@@ -1,6 +1,6 @@
# Contact Us # 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. Join our developers group.

8
docs-source/src/en/about/future.md
View File

@@ -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`. > 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. > 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. 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 `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 > The following example

12
docs-source/src/en/config/r8-proguard.md
View File

@@ -1,17 +1,17 @@
# R8 & Proguard Obfuscate # R8 & Proguard Obfuscation
> In most scenarios, the app packages can be compressed through obfuscation, > In most scenarios, app packages can be compressed through obfuscation.
> here is an introduction to how to configure obfuscation rules. > 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 -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** -keep class com.highcapable.hikage**

14
docs-source/src/en/guide/home.md
View File

@@ -1,10 +1,10 @@
# Introduce # Introduction
> `Hikage` (Pronunciation /ˈhɪkɑːɡeɪ/) is an Android responsive UI building tool. > `Hikage` (Pronunciation /ˈhɪkɑːɡeɪ/) is an Android responsive UI building tool.
## Background ## 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 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!!!!!". 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
**<u>Hikage is just a UI build tool and does not provide any UI components themselves</u>**. **<u>Hikage is just a UI build tool and does not provide any UI components themselves</u>**.
Rejecting duplicate wheels, our solution is always compatible and efficient. Now you can abandon ViewBinding and XML and even `findViewById` and try 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. using code layout directly.
`Hikage` works better with another project [BetterAndroid](https://github.com/BetterAndroid/BetterAndroid) and `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` itself will automatically reference the `BetterAndroid`-related dependencies as the core content.
## Usage ## 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. 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. to make suggestions to us.

14
docs-source/src/en/guide/quick-start.md
View File

@@ -4,12 +4,12 @@
## Project Requirements ## Project Requirements
The project needs to be created using `Android Studio` or `IntelliJ IDEA` and be of type Android or Kotlin Multiplatform The project needs to be created using `Android Studio` or `IntelliJ IDEA` and must be an Android or Kotlin Multiplatform
project and have integrated Kotlin environment dependencies. 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+ - Kotlin 1.9.0+, Gradle 8+, Java 17+, Android Gradle Plugin 8+
@@ -38,7 +38,7 @@ repositories:
#### Traditional Method #### Traditional Method
Configure repositories in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
repositories { repositories {
@@ -53,7 +53,7 @@ repositories {
### Configure Java Version ### 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 > Kotlin DSL
@@ -85,5 +85,5 @@ Click the corresponding module below to view detailed feature descriptions.
## Demo ## 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. select the functions you need.

4
docs-source/src/en/index.md
View File

@@ -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. 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 - title: Fully Compatible
details: Supports embedding and mixing XML, ViewBinding, and Jetpack Compose, and provides support for Material components and Jetpack. details: Supports embedding and mixing XML, ViewBinding, and Jetpack Compose, and provides support for Material components and Jetpack.
- title: Quickly Started - title: Quick to Start
details: Simple and easy to use it now! Do not need complex configuration and full development experience, Integrate dependencies and enjoy yourself. 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 footer: Apache-2.0 License | Copyright (C) 2019 HighCapable
--- ---

10
docs-source/src/en/library/hikage-compiler.md
View File

@@ -33,7 +33,7 @@ libraries:
version: + version: +
``` ```
Configure dependency in your root project `build.gradle.kts`. Configure dependency in your root project's `build.gradle.kts`.
```kotlin ```kotlin
plugins { plugins {
@@ -42,7 +42,7 @@ plugins {
} }
``` ```
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
plugins { 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" } 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 ```kotlin
plugins { plugins {
@@ -81,7 +81,7 @@ plugins {
} }
``` ```
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
plugins { plugins {
@@ -109,7 +109,7 @@ plugins {
} }
``` ```
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
plugins { plugins {

8
docs-source/src/en/library/hikage-core.md
View File

@@ -23,7 +23,7 @@ libraries:
version: + version: +
``` ```
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation(com.highcapable.hikage.hikage.core) implementation(com.highcapable.hikage.hikage.core)
@@ -41,7 +41,7 @@ hikage-core = "<version>"
hikage-core = { module = "com.highcapable.hikage:hikage-core", version.ref = "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 ```kotlin
implementation(libs.hikage.core) implementation(libs.hikage.core)
@@ -51,7 +51,7 @@ Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation("com.highcapable.hikage:hikage-core:<version>") implementation("com.highcapable.hikage:hikage-core:<version>")
@@ -96,7 +96,7 @@ val root = hikage.root
activity.setContentView(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 ### Layout Agreement

6
docs-source/src/en/library/hikage-extension-betterandroid.md
View File

@@ -23,7 +23,7 @@ libraries:
version: + version: +
``` ```
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation(com.highcapable.hikage.hikage.extension.betterandroid) implementation(com.highcapable.hikage.hikage.extension.betterandroid)
@@ -41,7 +41,7 @@ hikage-extension-betterandroid = "<version>"
hikage-extension-betterandroid = { module = "com.highcapable.hikage:hikage-extension-betterandroid", version.ref = "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 ```kotlin
implementation(libs.hikage.extension.betterandroid) implementation(libs.hikage.extension.betterandroid)
@@ -51,7 +51,7 @@ Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation("com.highcapable.hikage:hikage-extension-betterandroid:<version>") implementation("com.highcapable.hikage:hikage-extension-betterandroid:<version>")

6
docs-source/src/en/library/hikage-extension-compose.md
View File

@@ -31,7 +31,7 @@ libraries:
version: + version: +
``` ```
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation(com.highcapable.hikage.hikage.extension.compose) implementation(com.highcapable.hikage.hikage.extension.compose)
@@ -49,7 +49,7 @@ hikage-extension-compose = "<version>"
hikage-extension-compose = { module = "com.highcapable.hikage:hikage-extension-compose", version.ref = "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 ```kotlin
implementation(libs.hikage.extension.compose) implementation(libs.hikage.extension.compose)
@@ -59,7 +59,7 @@ Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation("com.highcapable.hikage:hikage-extension-compose:<version>") implementation("com.highcapable.hikage:hikage-extension-compose:<version>")

6
docs-source/src/en/library/hikage-extension.md
View File

@@ -23,7 +23,7 @@ libraries:
version: + version: +
``` ```
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation(com.highcapable.hikage.hikage.extension) implementation(com.highcapable.hikage.hikage.extension)
@@ -41,7 +41,7 @@ hikage-extension = "<version>"
hikage-extension = { module = "com.highcapable.hikage:hikage-extension", version.ref = "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 ```kotlin
implementation(libs.hikage.extension) implementation(libs.hikage.extension)
@@ -51,7 +51,7 @@ Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation("com.highcapable.hikage:hikage-extension:<version>") implementation("com.highcapable.hikage:hikage-extension:<version>")

6
docs-source/src/en/library/hikage-widget-androidx.md
View File

@@ -23,7 +23,7 @@ libraries:
version: + version: +
``` ```
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation(com.highcapable.hikage.hikage.widget.androidx) implementation(com.highcapable.hikage.hikage.widget.androidx)
@@ -41,7 +41,7 @@ hikage-widget-androidx = "<version>"
hikage-widget-androidx = { module = "com.highcapable.hikage:hikage-widget-androidx", version.ref = "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 ```kotlin
implementation(libs.hikage.widget.androidx) implementation(libs.hikage.widget.androidx)
@@ -51,7 +51,7 @@ Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation("com.highcapable.hikage:hikage-widget-androidx:<version>") implementation("com.highcapable.hikage:hikage-widget-androidx:<version>")

6
docs-source/src/en/library/hikage-widget-material.md
View File

@@ -23,7 +23,7 @@ libraries:
version: + version: +
``` ```
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation(com.highcapable.hikage.hikage.widget.material) implementation(com.highcapable.hikage.hikage.widget.material)
@@ -41,7 +41,7 @@ hikage-widget-material = "<version>"
hikage-widget-material = { module = "com.highcapable.hikage:hikage-widget-material", version.ref = "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 ```kotlin
implementation(libs.hikage.widget.material) implementation(libs.hikage.widget.material)
@@ -51,7 +51,7 @@ Please change `<version>` to the version displayed at the top of this document.
### Traditional Method ### Traditional Method
Configure dependency in your project `build.gradle.kts`. Configure dependency in your project's `build.gradle.kts`.
```kotlin ```kotlin
implementation("com.highcapable.hikage:hikage-widget-material:<version>") implementation("com.highcapable.hikage:hikage-widget-material:<version>")