Skip to content

Commit 1a36378

Browse files
committed
feat: update projects
1 parent 9707900 commit 1a36378

File tree

60 files changed

+247
-234
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+247
-234
lines changed

src/.vitepress/locale-config/en-gb.ts

Lines changed: 16 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,9 @@ export const britishEnglishConfig: LocaleSpecificConfig<DefaultTheme.Config> & {
1919
text: "Projects",
2020
items: [
2121
{
22-
text: "Java Dev Kit",
23-
link: "/projects/java-dev-kit"
24-
},
25-
{
26-
text: "Version Catalogue",
27-
link: "/projects/version-catalogue",
28-
},
29-
{ text: "Common Toolkit", link: "/projects/common-toolkit" },
30-
{
31-
text: "Identity Generator",
32-
link: "/projects/identity-generator",
33-
},
34-
{ text: "Crypto Toolkit", link: "/projects/crypto-toolkit" },
35-
{ text: "Math Toolkit", link: "/projects/math-toolkit" },
36-
{
37-
text: "JWT Toolkit",
38-
link: "/projects/jwt-toolkit",
39-
},
22+
text: "OnixByte Toolbox",
23+
link: "/projects/onixbyte-toolbox"
24+
}
4025
],
4126
},
4227
],
@@ -54,69 +39,26 @@ export const britishEnglishConfig: LocaleSpecificConfig<DefaultTheme.Config> & {
5439
text: "Open Source Projects",
5540
items: [
5641
{
57-
text: "Java Dev Kit",
58-
link: "/projects/java-dev-kit"
59-
},
60-
{
61-
text: "Version Catalogue",
62-
link: "/projects/version-catalogue",
63-
},
64-
{ text: "Common Toolkit", link: "/projects/common-toolkit" },
65-
{
66-
text: "Identity Generator",
67-
link: "/projects/identity-generator",
68-
},
69-
{ text: "Crypto Toolkit", link: "/projects/crypto-toolkit" },
70-
{ text: "Math Toolkit", link: "/projects/math-toolkit" },
71-
{
72-
text: "JWT Toolkit",
73-
link: "/projects/jwt-toolkit",
74-
},
42+
text: "OnixByte Toolbox",
43+
link: "/projects/onixbyte-toolbox"
44+
}
7545
],
7646
},
7747
],
78-
"/projects/java-dev-kit": [
48+
"/projects/onixbyte-toolbox": [
7949
{
8050
text: "Project",
81-
items: projectSidebar("java-dev-kit")
51+
items: [
52+
{ text: "Intro", link: `/projects/onixbyte-toolbox/` },
53+
{ text: "Usage", link: `/projects/onixbyte-toolbox/usage` },
54+
{ text: "API", link: `/projects/onixbyte-toolbox/api` },
55+
{
56+
text: "Changelog",
57+
link: `/projects/onixbyte-toolbox/changelog`,
58+
},
59+
]
8260
}
8361
],
84-
"/projects/version-catalogue": [
85-
{
86-
text: "Project",
87-
items: projectSidebar("version-catalogue"),
88-
},
89-
],
90-
"/projects/common-toolkit/": [
91-
{
92-
text: "Project",
93-
items: projectSidebar("common-toolkit"),
94-
},
95-
],
96-
"/projects/identity-generator/": [
97-
{
98-
text: "Project",
99-
items: projectSidebar("identity-generator"),
100-
},
101-
],
102-
"/projects/crypto-toolkit/": [
103-
{
104-
text: "Project",
105-
items: projectSidebar("crypto-toolkit"),
106-
},
107-
],
108-
"/projects/math-toolkit/": [
109-
{
110-
text: "Project",
111-
items: projectSidebar("math-toolkit"),
112-
},
113-
],
114-
"/projects/jwt-toolkit/": [
115-
{
116-
text: "Project",
117-
items: projectSidebar("jwt-toolkit"),
118-
},
119-
],
12062
},
12163
},
12264
}

src/.vitepress/locale-config/zh-cn.ts

Lines changed: 17 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,8 @@ export const simplifiedChineseConfig: LocaleSpecificConfig<DefaultTheme.Config>
1818
text: "项目",
1919
items: [
2020
{
21-
text: "Java Dev Kit",
22-
link: "/zh-CN/projects/java-dev-kit"
23-
},
24-
{
25-
text: "Version Catalogue",
26-
link: "/zh-CN/projects/version-catalogue",
27-
},
28-
{ text: "Common Toolkit", link: "/zh-CN/projects/common-toolkit" },
29-
{
30-
text: "Identity Generator",
31-
link: "/zh-CN/projects/identity-generator",
32-
},
33-
{ text: "Crypto Toolkit", link: "/zh-CN/projects/crypto-toolkit" },
34-
{ text: "Math Toolkit", link: "/zh-CN/projects/math-toolkit" },
35-
{
36-
text: "JWT Toolkit",
37-
link: "/zh-CN/projects/jwt-toolkit",
21+
text: "OnixByte 工具箱",
22+
link: "/zh-CN/projects/onixbyte-toolbox",
3823
},
3924
],
4025
},
@@ -56,57 +41,27 @@ export const simplifiedChineseConfig: LocaleSpecificConfig<DefaultTheme.Config>
5641
text: "开源项目",
5742
items: [
5843
{
59-
text: "Version Catalogue",
60-
link: "/zh-CN/projects/version-catalogue",
61-
},
62-
{ text: "Common Toolkit", link: "/zh-CN/projects/common-toolkit" },
63-
{
64-
text: "Identity Generator",
65-
link: "/zh-CN/projects/identity-generator",
66-
},
67-
{ text: "Crypto Toolkit", link: "/zh-CN/projects/crypto-toolkit" },
68-
{ text: "Math Toolkit", link: "/zh-CN/projects/math-toolkit" },
69-
{
70-
text: "JWT Toolkit",
71-
link: "/zh-CN/projects/jwt-toolkit",
44+
text: "OnixByte 工具箱",
45+
link: "/zh-CN/projects/onixbyte-toolbox",
7246
},
7347
],
7448
},
7549
],
76-
"/zh-CN/projects/version-catalogue": [
77-
{
78-
text: "项目",
79-
items: projectSidebar("version-catalogue", Locale.ZH_CN),
80-
},
81-
],
82-
"/zh-CN/projects/common-toolkit/": [
83-
{
84-
text: "项目",
85-
items: projectSidebar("common-toolkit", Locale.ZH_CN),
86-
},
87-
],
88-
"/zh-CN/projects/identity-generator/": [
50+
"/zh-CN/projects/onixbyte-toolbox": [
8951
{
9052
text: "项目",
91-
items: projectSidebar("identity-generator", Locale.ZH_CN),
92-
},
93-
],
94-
"/zh-CN/projects/crypto-toolkit/": [
95-
{
96-
text: "项目",
97-
items: projectSidebar("crypto-toolkit", Locale.ZH_CN),
98-
},
99-
],
100-
"/zh-CN/projects/math-toolkit/": [
101-
{
102-
text: "项目",
103-
items: projectSidebar("math-toolkit", Locale.ZH_CN),
104-
},
105-
],
106-
"/zh-CN/projects/jwt-toolkit/": [
107-
{
108-
text: "项目",
109-
items: projectSidebar("jwt-toolkit", Locale.ZH_CN),
53+
items: [
54+
{ text: "简介", link: "/zh-CN/projects/onixbyte-toolbox/" },
55+
{
56+
text: "使用",
57+
link: "/zh-CN/projects/onixbyte-toolbox/usage",
58+
},
59+
{ text: "API", link: `/zh-CN/projects/onixbyte-toolbox/api` },
60+
{
61+
text: "更新日志",
62+
link: `/zh-CN/projects/onixbyte-toolbox/changelog`,
63+
},
64+
],
11065
},
11166
],
11267
},

src/projects/common-toolkit/index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

src/projects/crypto-toolkit/changelog.md

Whitespace-only changes.

src/projects/crypto-toolkit/index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

src/projects/crypto-toolkit/usage.md

Whitespace-only changes.

src/projects/identity-generator/api.md

Whitespace-only changes.

src/projects/identity-generator/changelog.md

Whitespace-only changes.

src/projects/identity-generator/index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

src/projects/identity-generator/usage.md

Whitespace-only changes.

src/projects/java-dev-kit/api.md

Whitespace-only changes.

src/projects/java-dev-kit/usage.md

Whitespace-only changes.

src/projects/jwt-toolkit/api.md

Whitespace-only changes.

src/projects/jwt-toolkit/changelog.md

Whitespace-only changes.

src/projects/jwt-toolkit/index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

src/projects/jwt-toolkit/usage.md

Whitespace-only changes.

src/projects/math-toolkit/api.md

Whitespace-only changes.

src/projects/math-toolkit/changelog.md

Whitespace-only changes.

src/projects/math-toolkit/index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

src/projects/math-toolkit/usage.md

Whitespace-only changes.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024-2025 OnixByte
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
Lines changed: 52 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,76 @@
1-
# Java Dev Kit <Badge type="info">2.3.0</Badge>
1+
# OnixByte Toolbox <Badge type="info">3.0.0</Badge>
22

3-
Java Dev Kit is an open-source enterprise-grade Java development toolkit suite, designed to
3+
OnixByte Toolbox is an open-source enterprise-grade Java development toolkit suite, designed to
44
streamline and enhance your software development workflow. It provides a collection of modular tools
55
and utilities tailored for various aspects of Java application development.
66

7+
## Installation
8+
9+
You can install our toolbox by adding following codes to your build script.
10+
11+
::: code-group
12+
13+
```xml [Maven]
14+
<dependencies>
15+
<dependency>
16+
<groupId>com.onixbyte</groupId>
17+
<artifactId>${artefactId}</artifactId>
18+
<version>${version}</version>
19+
</dependency>
20+
</dependencies>
21+
```
22+
23+
```kotlin [Gradle (Kotlin DSL)]
24+
dependencies {
25+
implementation("com.onixbyte:$artefactId:$version")
26+
}
27+
```
28+
29+
```groovy [Gradle (Groovy DSL)]
30+
dependencies {
31+
implementation 'com.onixbyte:$artefactId:$version'
32+
}
33+
```
34+
35+
:::
36+
737
## Features
838

9-
### 1. Version Management Module
39+
### 1. Version Catalogue
40+
1041
This module handles overall project management by utilising a BOM (Bill of Materials) to uniformly
1142
manage the versions of all imported dependencies, ensuring consistency and reducing version
1243
conflicts across your projects.
1344

14-
### 2. Development Utility Tools
45+
### 2. Common Toolkit
46+
1547
A comprehensive set of practical utilities to simplify common development tasks, including but not
1648
limited to:
1749

1850
- **AesUtil**: Provides AES encryption functionality.
1951
- **Base64Util**: Performs Base64 encoding and decoding for strings.
2052
- **BoolUtil**: Executes logical AND and OR operations on multiple boolean expressions.
21-
- **BranchUtil**: Reduces verbose `if-else` statements by combining `BoolUtil` with Lambda expressions for cleaner conditional flows.
53+
- **BranchUtil**: Reduces verbose `if-else` statements by combining `BoolUtil` with Lambda
54+
expressions for cleaner conditional flows.
2255
- **CollectionUtil**: Utilities designed for convenient and efficient collection handling.
2356
- **HashUtil**: Offers hashing operations on strings using various algorithms.
24-
- **MapUtil** and **ObjectMapAdapter**: Facilitate conversions between `Map` objects and specified Java classes.
57+
- **MapUtil** and **ObjectMapAdapter**: Facilitate conversions between `Map` objects and specified
58+
Java classes.
2559
- **RangeUtil**: Generates ranged arrays based on specified bounds.
2660

27-
### 3. Global Unique ID Generator
61+
### 3. Identity Generator
62+
2863
A dedicated module providing a variety of generators for creating different types of globally unique
2964
identifiers (GUIDs), suitable for distributed systems and enterprise applications.
3065

31-
### 4. Key Pair Loading Utilities
66+
### 4. Crypto Toolkit
67+
3268
Tools to load PEM-format key pair files (`PublicKey` and `PrivateKey`) into their corresponding Java
3369
objects. This utility can also be integrated within the main development utilities module for
3470
better cohesion.
3571

36-
### 5. Mathematics and Statistics Utilities
72+
### 5. Math Toolkit
73+
3774
A set of tools for mathematical and statistical computations, currently supporting:
3875

3976
- Chainable high-precision calculations.
@@ -42,34 +79,21 @@ A set of tools for mathematical and statistical computations, currently supporti
4279
Consideration is given to merging this into the development utilities module for simplicity and
4380
easy access.
4481

45-
### 6. JWT Tools
46-
Employing a facade pattern, Java Dev Kit allows the utilisation of various implementations for
47-
generating, parsing, and verifying JSON Web Tokens (JWT), making token management flexible
48-
and extensible.
49-
50-
### 7. Serial Number Generator
51-
A utility to generate serial numbers following specified formats, useful for identifiers,
52-
order numbers, and other sequential data.
53-
5482
## Getting Started
5583

56-
To include Java Dev Kit in your project, please refer to the version management module’s BOM to
84+
To include OnixByte Toolbox in your project, please refer to the version management module’s BOM to
5785
ensure you use compatible and consistent dependency versions.
5886

5987
## Contributing
6088

61-
Java Dev Kit is open source and welcomes contributions. Please feel free to submit issues and pull
62-
requests to help improve the toolkit.
89+
OnixByte Toolbox is open source and welcomes contributions. Please feel free to submit issues and
90+
pull requests to help improve the toolkit.
6391

6492
## Licence
6593

66-
This project is licensed under the Apache Licence. See the LICENSE file for details.
67-
68-
---
69-
70-
For more detailed documentation on each module and usage examples, please refer to the `/docs`
71-
directory or visit the project wiki.
94+
This project is licensed under MIT Licence. See the LICENSE file for details. You may refer to the
95+
[License](/projects/onixbyte-toolbox/LICENSE.txt) here.
7296

7397
---
7498

75-
Thank you for using Java Dev Kit, your trusted companion for enterprise Java development.
99+
Thank you for using OnixByte Toolbox, your trusted companion for enterprise Java development.

0 commit comments

Comments
 (0)