onixbyte/homepage
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: optimise docs

Browse Source
This commit is contained in:
Zihlu Wang
2026-05-23 15:07:43 +08:00
parent 601625f09b
commit b051d8c235
4 changed files with 78 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files
LICENCE
+1 -1
View File
@@ -1,4 +1,4 @@
MIT License MIT Licence
Copyright (c) 2026 OnixByte Copyright (c) 2026 OnixByte
docs/en-gb/projects/onixbyte-toolbox/index.mdx
+29 -29
View File
@@ -2,6 +2,8 @@
title: OnixByte Toolbox title: OnixByte Toolbox
--- ---
import { Tabs, Tab } from "@rspress/core/theme"
## Introduction ## Introduction
OnixByte Toolbox is a Development Kit for Java applications that provides a set of convenient, reusable tools for writing code efficiently. It is designed and maintained by OnixByte as a monorepo containing multiple purpose-built libraries, each addressing a specific development need — from common utilities and cryptography to mathematical computation and identity generation. OnixByte Toolbox is a Development Kit for Java applications that provides a set of convenient, reusable tools for writing code efficiently. It is designed and maintained by OnixByte as a monorepo containing multiple purpose-built libraries, each addressing a specific development need — from common utilities and cryptography to mathematical computation and identity generation.
@@ -10,40 +12,38 @@ The toolkit is available on Maven Central under the `com.onixbyte` group ID. Eac
## Modules ## Modules
| Module | Artifact ID | Description | | Module | Artifact ID | Description |
|----------------------|-----------------------|-------------------------------------------------------| |--------------------|----------------------|---------------------------------------------------------------------------|
| Common Toolbox | `common-toolbox` | Everyday utilities — AES, hashing, Base64, collections, branching, ranges | | Common Toolbox | `common-toolbox` | Everyday utilities — AES, hashing, Base64, collections, branching, ranges |
| Crypto Toolbox | `crypto-toolbox` | Public/private key loading for RSA and ECDSA algorithms | | Crypto Toolbox | `crypto-toolbox` | Public/private key loading for RSA and ECDSA algorithms |
| Math Toolbox | `math-toolbox` | Statistical calculation, percentile analysis, quartile computation | | Math Toolbox | `math-toolbox` | Statistical calculation, percentile analysis, quartile computation |
| Tuple | `tuple` | Generic 2-tuple and 3-tuple with immutable variants | | Tuple | `tuple` | Generic 2-tuple and 3-tuple with immutable variants |
| Identity Generator | `identity-generator` | Snowflake-style and sequential UUID identity generation | | Identity Generator | `identity-generator` | Snowflake-style and sequential UUID identity generation |
| Version Catalogue | `version-catalogue` | Centralised Gradle version catalogue for OnixByte projects | | Version Catalogue | `version-catalogue` | Centralised Gradle version catalogue for OnixByte projects |
## Installation ## Installation
Add the desired module as a dependency in your build config: Add the desired module as a dependency in your build config:
**Gradle (Kotlin DSL):** <Tabs>
<Tab label="Gradle with Kotlin DSL">
```kotlin title="build.gradle.kts"
dependencies {
implementation("com.onixbyte:$artefactId:$version")
}
```
</Tab>
```kotlin <Tab label="Maven">
implementation("com.onixbyte:common-toolbox:$version") ```xml title="pom.xml"
implementation("com.onixbyte:crypto-toolbox:$version") <dependency>
implementation("com.onixbyte:math-toolbox:$version") <groupId>com.onixbyte</groupId>
implementation("com.onixbyte:tuple:$version") <artifactId>${artefactId}</artifactId>
implementation("com.onixbyte:identity-generator:$version") <version>${version}</version>
``` </dependency>
```
**Maven:** </Tab>
</Tabs>
```xml
<dependency>
<groupId>com.onixbyte</groupId>
<artifactId>common-toolbox</artifactId>
<version>${version}</version>
</dependency>
```
Refer to the [changelog](https://codecrafters.org.cn/devkit/changelog) for available versions.
## Requirements ## Requirements
@@ -51,4 +51,4 @@ Refer to the [changelog](https://codecrafters.org.cn/devkit/changelog) for avail
## License ## License
OnixByte Toolbox is open-source software released under the MIT License. OnixByte Toolbox is open-source software released under the MIT Licence.
docs/zh-hans/projects/onixbyte-toolbox/index.mdx
+28 -28
View File
@@ -2,6 +2,8 @@
title: OnixByte Toolbox title: OnixByte Toolbox
--- ---
import { Tabs, Tab } from "@rspress/core/theme"
## 介绍 ## 介绍
OnixByte Toolbox 是一个面向 Java 应用的开发工具包，提供了一系列便捷、可复用的工具，帮助开发者高效编写代码。它由 OnixByte 设计和维护，采用 monorepo 架构，包含多个专用库，每个库解决一个特定的开发需求 — 从通用工具类和密码学，到数学计算和标识符生成。 OnixByte Toolbox 是一个面向 Java 应用的开发工具包，提供了一系列便捷、可复用的工具，帮助开发者高效编写代码。它由 OnixByte 设计和维护，采用 monorepo 架构，包含多个专用库，每个库解决一个特定的开发需求 — 从通用工具类和密码学，到数学计算和标识符生成。
@@ -10,40 +12,38 @@ OnixByte Toolbox 是一个面向 Java 应用的开发工具包，提供了一系
## 模块 ## 模块
| 模块 | Artifact ID | 描述 | | 模块 | Artifact ID | 描述 |
|---|---|---| |--------------------|----------------------|-----------------------------------|
| Common Toolbox | `common-toolbox` | 日常工具类 — AES 加密、哈希、Base64、集合、分支、范围 | | Common Toolbox | `common-toolbox` | 日常工具类 — AES 加密、哈希、Base64、集合、分支、范围 |
| Crypto Toolbox | `crypto-toolbox` | RSA 和 ECDSA 算法的公私钥加载 | | Crypto Toolbox | `crypto-toolbox` | RSA 和 ECDSA 算法的公私钥加载 |
| Math Toolbox | `math-toolbox` | 统计计算、百分位数分析、四分位数计算 | | Math Toolbox | `math-toolbox` | 统计计算、百分位数分析、四分位数计算 |
| Tuple | `tuple` | 泛型二元组和三元组，含不可变版本 | | Tuple | `tuple` | 泛型二元组和三元组，含不可变版本 |
| Identity Generator | `identity-generator` | 雪花算法和顺序 UUID 唯一标识符生成 | | Identity Generator | `identity-generator` | 雪花算法和顺序 UUID 唯一标识符生成 |
| Version Catalogue | `version-catalogue` | OnixByte 项目的集中式 Gradle 版本目录 | | Version Catalogue | `version-catalogue` | OnixByte 项目的集中式 Gradle 版本目录 |
## 安装 ## 安装
在构建配置中添加所需模块的依赖： 在构建配置中添加所需模块的依赖：
**Gradle (Kotlin DSL):** <Tabs>
<Tab label="Gradle with Kotlin DSL">
```kotlin title="build.gradle.kts"
dependencies {
implementation("com.onixbyte:$artefactId:$version")
}
```
</Tab>
```kotlin <Tab label="Maven">
implementation("com.onixbyte:common-toolbox:$version") ```xml title="pom.xml"
implementation("com.onixbyte:crypto-toolbox:$version") <dependency>
implementation("com.onixbyte:math-toolbox:$version") <groupId>com.onixbyte</groupId>
implementation("com.onixbyte:tuple:$version") <artifactId>${artefactId}</artifactId>
implementation("com.onixbyte:identity-generator:$version") <version>${version}</version>
``` </dependency>
```
**Maven:** </Tab>
</Tabs>
```xml
<dependency>
<groupId>com.onixbyte</groupId>
<artifactId>common-toolbox</artifactId>
<version>${version}</version>
</dependency>
```
可查阅[更新日志](https://codecrafters.org.cn/devkit/changelog)了解可用版本。
## 要求 ## 要求
docs/zh-hans/projects/regions4j/index.mdx
+20 -14
View File
@@ -2,6 +2,8 @@
title: Regions for Java title: Regions for Java
--- ---
import { Tabs, Tab } from "@rspress/core/theme"
## 介绍 ## 介绍
**regions4j** 是一个轻量级、类型安全的 Java 库，基于 ISO 3166-1 标准提供全面的世界地区元数据。它旨在简化 Java 企业应用中的国际化（i18n）、电信路由和地区数据管理工作。 **regions4j** 是一个轻量级、类型安全的 Java 库，基于 ISO 3166-1 标准提供全面的世界地区元数据。它旨在简化 Java 企业应用中的国际化（i18n）、电信路由和地区数据管理工作。
@@ -30,21 +32,25 @@ title: Regions for Java
## 安装 ## 安装
**Maven:** <Tabs>
<Tab label="Gradle with Kotlin DSL">
```kotlin title="build.gradle.kts"
dependencies {
implementation("com.onixbyte:regions4j:$version")
}
```
</Tab>
```xml <Tab label="Maven">
<dependency> ```xml title="pom.xml"
<groupId>com.onixbyte</groupId> <dependency>
<artifactId>regions4j</artifactId> <groupId>com.onixbyte</groupId>
<version>2025.12</version> <artifactId>regions4j</artifactId>
</dependency> <version>${version}</version>
``` </dependency>
```
**Gradle (Kotlin DSL):** </Tab>
</Tabs>
```kotlin
implementation("com.onixbyte:regions4j:2025.12")
```
> **版本说明：** 该库使用日历化版本管理（`YYYY.MM`）而非语义化版本号。版本字符串如 `2025.12` 可以直观地告诉您地区数据反映的是 2025 年 12 月的 ISO 3166-1 状态。 > **版本说明：** 该库使用日历化版本管理（`YYYY.MM`）而非语义化版本号。版本字符串如 `2025.12` 可以直观地告诉您地区数据反映的是 2025 年 12 月的 ISO 3166-1 状态。