Skip to content

Commit 10b1f6a

Browse files
LessUpLessUp
committed
docs: simplify homepage to minimal layout
- Remove StatsBar, AlgorithmGrid, feature cards - Keep hero, quick start, algorithm table, cross-language demo - Cleaner, faster loading, less visual noise
1 parent 592d08f commit 10b1f6a

2 files changed

Lines changed: 46 additions & 130 deletions

File tree

‎docs/en/index.md‎

Lines changed: 24 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -4,86 +4,46 @@ layout: home
44
hero:
55
name: CompressKit
66
text: Compression algorithms you can trust
7-
tagline: Production-ready Huffman, Arithmetic, Range, and RLE implementations in C++, Go, and Rust. Verified across languages, documented for learning.
8-
image:
9-
src: /logo.svg
10-
alt: CompressKit Logo
7+
tagline: Huffman, Arithmetic, Range, and RLE in C++17, Go, and Rust
118
actions:
129
- theme: brand
13-
text: Quick Start
10+
text: Get Started
1411
link: /en/guide/getting-started
1512
- theme: alt
16-
text: Compare Algorithms
17-
link: /en/guide/algorithms
18-
- theme: alt
19-
text: 中文
20-
link: /zh/
21-
22-
features:
23-
- icon: 🔄
24-
title: Cross-language verified
25-
details: Every algorithm is implemented in C++17, Go, and Rust with identical binary formats. Encode in one language, decode in another.
26-
- icon: 📚
27-
title: Learn by reading
28-
details: Clean, well-commented code designed for education. Each implementation fits in a single file you can actually read.
29-
- icon: ⚡
30-
title: Production-ready
31-
details: Security limits (4 GiB input, 1 GiB output), streaming APIs, comprehensive tests, and clear documentation.
32-
- icon: 🧪
33-
title: Test-driven quality
34-
details: 144 cross-language conformance tests ensure binary compatibility. Every release is verified before shipping.
13+
text: View on GitHub
14+
link: https://github.com/LessUp/compress-kit
3515
---
3616

37-
<StatsBar />
38-
39-
## Why CompressKit?
40-
41-
| You need | We provide |
42-
|----------|------------|
43-
| Learn compression algorithms | Read implementations that fit in one file |
44-
| Cross-language compatibility | Verified binary formats across C++/Go/Rust |
45-
| Production use | Streaming APIs, security limits, error handling |
46-
| Benchmark comparison | Run `make bench` and see real numbers |
47-
48-
## Algorithm Selection Guide
49-
50-
<AlgorithmGrid />
51-
52-
## Get started in 30 seconds
17+
## Quick Start
5318

5419
```bash
5520
git clone https://github.com/LessUp/compress-kit.git
5621
cd compress-kit
5722
make build && make test
5823
```
5924

60-
That's it. All 12 implementations (4 algorithms × 3 languages) built and tested.
61-
62-
## What makes this different
63-
64-
**Not another "compress everything" library.** CompressKit is a compression laboratory:
25+
## Algorithms
6526

66-
- **Transparent formats** — No opaque magic, every byte documented
67-
- **Isomorphic implementations** — Same algorithm, same output, different languages
68-
- **Educational focus** — Code you can read, tests you can trace
69-
- **Verification-first** — Cross-language conformance is a test, not an afterthought
27+
| Algorithm | Best For | Speed |
28+
|-----------|----------|-------|
29+
| [Huffman](/en/algorithms/huffman) | General purpose, text | Fast |
30+
| [Arithmetic](/en/algorithms/arithmetic) | Maximum compression | Medium |
31+
| [Range Coder](/en/algorithms/range) | Production systems | Fast |
32+
| [RLE](/en/algorithms/rle) | Repetitive data | Very Fast |
7033

71-
## Magic Numbers
34+
## Cross-Language Compatibility
7235

73-
Every algorithm has a 4-byte magic header for instant file identification:
36+
Encode in C++, decode in Go. Encode in Rust, decode in C++. All implementations produce identical binary output.
7437

75-
| Algorithm | Magic | Description |
76-
|-----------|-------|-------------|
77-
| Huffman | `HFMN` | Prefix-code based compression |
78-
| Arithmetic | `AENC` | Entropy-optimal encoding |
79-
| Range Coder | `RCNC` | Fast integer arithmetic coding |
80-
| RLE | `RLE\x00` | Run-length compression |
38+
```bash
39+
# C++ encode, Go decode
40+
./cpp/huffman encode input.txt output.huf
41+
./go/huffman decode output.huf decoded.txt
42+
# Works perfectly — same bytes, different languages
43+
```
8144

82-
## Next Steps
45+
## Next
8346

84-
| Goal | Page |
85-
|------|------|
86-
| Build and run locally | [Getting Started](/en/guide/getting-started) |
87-
| Choose the right algorithm | [Algorithm Guide](/en/guide/algorithms) |
88-
| Use as a library | [Streaming API](/en/api/streaming) |
89-
| Verify compatibility | [Cross-Language Testing](/en/testing/cross-language) |
47+
- [Build instructions](/en/guide/getting-started) — Get running locally
48+
- [Algorithm guide](/en/guide/algorithms) — Choose the right one
49+
- [API reference](/en/api/streaming) — Use as a library

‎docs/zh/index.md‎

Lines changed: 22 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -4,90 +4,46 @@ layout: home
44
hero:
55
name: CompressKit
66
text: 值得信赖的压缩算法
7-
tagline: 生产级 Huffman、Arithmetic、Range 和 RLE 实现，支持 C++、Go 和 Rust。跨语言验证，文档完善，适合学习。
8-
image:
9-
src: /logo.svg
10-
alt: CompressKit Logo
7+
tagline: Huffman、Arithmetic、Range、RLE —— 支持 C++17、Go、Rust
118
actions:
129
- theme: brand
1310
text: 快速开始
1411
link: /zh/guide/getting-started
1512
- theme: alt
16-
text: 算法对比
17-
link: /zh/guide/algorithms
18-
- theme: alt
19-
text: English Docs
20-
link: /en/
21-
22-
features:
23-
- icon: 🔄
24-
title: 跨语言验证
25-
details: 每种算法均在 C++17、Go 和 Rust 中实现，二进制格式完全一致。一种语言编码，另一种语言解码。
26-
- icon: 📚
27-
title: 阅读即学习
28-
details: 代码清晰、注释完善，专为教育设计。每个实现都浓缩在单文件中，真正可读。
29-
- icon: ⚡
30-
title: 生产级就绪
31-
details: 安全限制（4 GiB 输入，1 GiB 输出）、流式 API、全面测试、清晰文档。
32-
- icon: 🧪
33-
title: 测试驱动质量
34-
details: 144 项跨语言一致性测试确保二进制兼容。每次发布前均经过完整验证。
13+
text: 查看 GitHub
14+
link: https://github.com/LessUp/compress-kit
3515
---
3616

37-
<StatsBar />
38-
39-
## 为什么选择 CompressKit？
40-
41-
<div class="ck-value-props">
42-
43-
| 你需要 | 我们提供 |
44-
|--------|----------|
45-
| 学习压缩算法 | 阅读单文件实现，代码清晰易懂 |
46-
| 跨语言兼容性 | C++/Go/Rust 验证的二进制格式 |
47-
| 生产环境使用 | 流式 API、安全限制、完善的错误处理 |
48-
| 性能对比基准 | 运行 `make bench` 获取真实数据 |
49-
50-
</div>
51-
52-
## 算法选择指南
53-
54-
<AlgorithmGrid />
55-
56-
## 30 秒快速上手
17+
## 快速开始
5718

5819
```bash
5920
git clone https://github.com/LessUp/compress-kit.git
6021
cd compress-kit
6122
make build && make test
6223
```
6324

64-
就这么简单。12 个实现（4 种算法 × 3 种语言）构建并测试完成。
65-
66-
## 独特之处
25+
## 算法
6726

68-
**不是"万能压缩库"。** CompressKit 是一个压缩算法实验室：
27+
| 算法 | 适用场景 | 速度 |
28+
|------|----------|------|
29+
| [Huffman](/zh/algorithms/huffman) | 通用压缩、文本 | 快 |
30+
| [Arithmetic](/zh/algorithms/arithmetic) | 最大压缩率 | 中 |
31+
| [Range Coder](/zh/algorithms/range) | 生产系统 | 快 |
32+
| [RLE](/zh/algorithms/rle) | 重复数据 | 极快 |
6933

70-
- **透明的格式** — 每个字节都有文档，没有黑盒魔法
71-
- **同构实现** — 相同算法，相同输出，不同语言
72-
- **教育优先** — 代码可读，测试可追踪
73-
- **验证为先** — 跨语言一致性是测试要求，而非事后补充
34+
## 跨语言兼容
7435

75-
## Magic Numbers
36+
C++ 编码，Go 解码。Rust 编码，C++ 解码。所有实现产生完全相同的二进制输出。
7637

77-
每个算法都有 4 字节的魔数头，用于即时文件识别：
78-
79-
| 算法 | Magic | 描述 |
80-
|------|-------|------|
81-
| Huffman | `HFMN` | 基于前缀码的压缩 |
82-
| Arithmetic | `AENC` | 熵最优编码 |
83-
| Range Coder | `RCNC` | 快速整数区间编码 |
84-
| RLE | `RLE\x00` | 行程长度压缩 |
38+
```bash
39+
# C++ 编码，Go 解码
40+
./cpp/huffman encode input.txt output.huf
41+
./go/huffman decode output.huf decoded.txt
42+
# 完美运行 —— 相同字节，不同语言
43+
```
8544

8645
## 下一步
8746

88-
| 目标 | 页面 |
89-
|------|------|
90-
| 本地构建运行 | [快速开始](/zh/guide/getting-started) |
91-
| 选择合适的算法 | [算法指南](/zh/guide/algorithms) |
92-
| 作为库使用 | [Streaming API](/zh/api/streaming) |
93-
| 验证兼容性 | [跨语言测试](/zh/testing/cross-language) |
47+
- [构建说明](/zh/guide/getting-started) — 本地运行
48+
- [算法指南](/zh/guide/algorithms) — 选择合适的算法
49+
- [API 参考](/zh/api/streaming) — 作为库使用

0 commit comments

Comments
 (0)