Skip to content

Commit 12c5b47

Browse files
authored
fix: readme contributors layout (#6)
* doc: add github page * test(doc): add test for doc page building * fix: github page * fix: right document hyperlink navigation; separate Chinese and English docs * doc: add history contributors * fix: readme contributors layout
1 parent 458c8ff commit 12c5b47

3 files changed

Lines changed: 65 additions & 76 deletions

File tree

README.md

Lines changed: 20 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
[![Latest](https://img.shields.io/badge/Latest-v0.2.1-f28500)](./fluxon_release)
1111
[![Interfaces](https://img.shields.io/badge/Interfaces-KV%2FRPC%20%7C%20MQ%20%7C%20FS-1f6feb)](#interface-capabilities)
1212

13-
[English](./README.md) | [中文](./README_CN.md) | [Docs](./README.md) | [中文文档](./README_CN.md)
13+
[English](./README.md) | [中文](./README_CN.md) | [Docs](./README.md) | [中文文档](./README_CN.md) | <a href="https://github.com/Tele-AI/fluxon" title="GitHub Repository"><svg width="18" height="18" viewBox="0 0 16 16" fill="currentColor" aria-label="GitHub repository"><path d="M8 0C3.58 0 0 3.58 0 8a8 8 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.66 7.66 0 0 1 8 4.84c.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg></a>
1414

1515
</div>
1616

@@ -237,43 +237,25 @@ Thank you for your contribution. Start with the local developer docs:
237237

238238
Some earlier contribution records are no longer fully reflected in the current commit history. Historical highlights:
239239

240-
<div>
241-
<a href="https://github.com/yxrxy" title="yxrxy - FluxonFS implementation and optimization" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
242-
<img src="https://github.com/yxrxy.png?size=64" width="64" height="64" alt="yxrxy" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
243-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">yxrxy</div>
244-
<div style="font-size: 0.8rem; line-height: 1.35;">FluxonFS implementation and optimization</div>
245-
</a>
246-
<a href="https://github.com/zTz01" title="zTz01 - KVCache optimization" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
247-
<img src="https://github.com/zTz01.png?size=64" width="64" height="64" alt="zTz01" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
248-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">zTz01</div>
249-
<div style="font-size: 0.8rem; line-height: 1.35;">KVCache optimization</div>
250-
</a>
251-
<a href="https://github.com/pakkah" title="pakkah - RDMA support, VLM exploration" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
252-
<img src="https://github.com/pakkah.png?size=64" width="64" height="64" alt="pakkah" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
253-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">pakkah</div>
254-
<div style="font-size: 0.8rem; line-height: 1.35;">RDMA support, VLM exploration</div>
255-
</a>
256-
<a href="https://github.com/mumupika" title="mumupika - Initial MQ implementation" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
257-
<img src="https://github.com/mumupika.png?size=64" width="64" height="64" alt="mumupika" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
258-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">mumupika</div>
259-
<div style="font-size: 0.8rem; line-height: 1.35;">Initial MQ implementation</div>
260-
</a>
261-
<a href="https://github.com/maplestarplayl" title="maplestarplayl - IPC integration, SPDK integration" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
262-
<img src="https://github.com/maplestarplayl.png?size=64" width="64" height="64" alt="maplestarplayl" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
263-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">maplestarplayl</div>
264-
<div style="font-size: 0.8rem; line-height: 1.35;">IPC integration, SPDK integration</div>
265-
</a>
266-
<a href="https://github.com/RuileLu" title="RuileLu - KV lease support" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
267-
<img src="https://github.com/RuileLu.png?size=64" width="64" height="64" alt="RuileLu" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
268-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">RuileLu</div>
269-
<div style="font-size: 0.8rem; line-height: 1.35;">KV lease support</div>
270-
</a>
271-
<a href="https://github.com/Summage" title="Summage - Initial KV architecture optimization" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
272-
<img src="https://github.com/Summage.png?size=64" width="64" height="64" alt="Summage" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
273-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">Summage</div>
274-
<div style="font-size: 0.8rem; line-height: 1.35;">Initial KV architecture optimization</div>
275-
</a>
276-
</div>
240+
<p>
241+
<a href="https://github.com/yxrxy"><img src="https://wsrv.nl/?url=github.com/yxrxy.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="yxrxy" /></a>
242+
<a href="https://github.com/zTz01"><img src="https://wsrv.nl/?url=github.com/zTz01.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="zTz01" /></a>
243+
<a href="https://github.com/pakkah"><img src="https://wsrv.nl/?url=github.com/pakkah.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="pakkah" /></a>
244+
<a href="https://github.com/unity1263"><img src="https://wsrv.nl/?url=github.com/unity1263.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="unity1263" /></a>
245+
<a href="https://github.com/mumupika"><img src="https://wsrv.nl/?url=github.com/mumupika.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="mumupika" /></a>
246+
<a href="https://github.com/maplestarplayl"><img src="https://wsrv.nl/?url=github.com/maplestarplayl.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="maplestarplayl" /></a>
247+
<a href="https://github.com/RuileLu"><img src="https://wsrv.nl/?url=github.com/RuileLu.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="RuileLu" /></a>
248+
<a href="https://github.com/Summage"><img src="https://wsrv.nl/?url=github.com/Summage.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="Summage" /></a>
249+
</p>
250+
251+
- `yxrxy`: FluxonFS implementation and optimization
252+
- `zTz01`: KVCache optimization
253+
- `pakkah`: RDMA support, VLM exploration
254+
- `unity1263`: KV shared-memory design integration, benchmark toolchain
255+
- `mumupika`: Initial MQ implementation
256+
- `maplestarplayl`: IPC integration, SPDK integration
257+
- `RuileLu`: KV lease support
258+
- `Summage`: Initial KV architecture optimization
277259

278260
## License
279261

README_CN.md

Lines changed: 20 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Fluxon 是一套面向世界模型与其他 AI-native 场景训推系统的高
1414
[![Latest](https://img.shields.io/badge/Latest-v0.2.1-f28500)](./fluxon_release)
1515
[![Interfaces](https://img.shields.io/badge/Interfaces-KV%2FRPC%20%7C%20MQ%20%7C%20FS-1f6feb)](#接口能力)
1616

17-
[中文](./README_CN.md) | [English](./README.md) | [用户文档](./README_CN.md) | [English Docs](./README.md)
17+
[中文](./README_CN.md) | [English](./README.md) | [用户文档](./README_CN.md) | [English Docs](./README.md) | <a href="https://github.com/Tele-AI/fluxon" title="GitHub 仓库"><svg width="18" height="18" viewBox="0 0 16 16" fill="currentColor" aria-label="GitHub repository"><path d="M8 0C3.58 0 0 3.58 0 8a8 8 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.66 7.66 0 0 1 8 4.84c.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg></a>
1818

1919
</div>
2020

@@ -239,43 +239,25 @@ FS Quick Start 会额外打印:
239239

240240
部分更早期的贡献记录已经无法从当前 commit 历史里完整反映,这里补充说明:
241241

242-
<div>
243-
<a href="https://github.com/yxrxy" title="yxrxy - FluxonFS 实现和优化" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
244-
<img src="https://github.com/yxrxy.png?size=64" width="64" height="64" alt="yxrxy" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
245-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">yxrxy</div>
246-
<div style="font-size: 0.8rem; line-height: 1.35;">FluxonFS 实现和优化</div>
247-
</a>
248-
<a href="https://github.com/zTz01" title="zTz01 - KVCache 优化" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
249-
<img src="https://github.com/zTz01.png?size=64" width="64" height="64" alt="zTz01" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
250-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">zTz01</div>
251-
<div style="font-size: 0.8rem; line-height: 1.35;">KVCache 优化</div>
252-
</a>
253-
<a href="https://github.com/pakkah" title="pakkah - RDMA 支持、VLM 探索" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
254-
<img src="https://github.com/pakkah.png?size=64" width="64" height="64" alt="pakkah" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
255-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">pakkah</div>
256-
<div style="font-size: 0.8rem; line-height: 1.35;">RDMA 支持、VLM 探索</div>
257-
</a>
258-
<a href="https://github.com/mumupika" title="mumupika - 初始 MQ 版本实现" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
259-
<img src="https://github.com/mumupika.png?size=64" width="64" height="64" alt="mumupika" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
260-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">mumupika</div>
261-
<div style="font-size: 0.8rem; line-height: 1.35;">初始 MQ 版本实现</div>
262-
</a>
263-
<a href="https://github.com/maplestarplayl" title="maplestarplayl - IPC 接入、SPDK 接入" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
264-
<img src="https://github.com/maplestarplayl.png?size=64" width="64" height="64" alt="maplestarplayl" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
265-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">maplestarplayl</div>
266-
<div style="font-size: 0.8rem; line-height: 1.35;">IPC 接入、SPDK 接入</div>
267-
</a>
268-
<a href="https://github.com/RuileLu" title="RuileLu - KV lease 功能支持" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
269-
<img src="https://github.com/RuileLu.png?size=64" width="64" height="64" alt="RuileLu" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
270-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">RuileLu</div>
271-
<div style="font-size: 0.8rem; line-height: 1.35;">KV lease 功能支持</div>
272-
</a>
273-
<a href="https://github.com/Summage" title="Summage - 初始 KV 架构设计优化" style="display: inline-block; width: 128px; margin: 0 10px 14px 0; vertical-align: top; text-align: center; text-decoration: none; color: inherit; font-size: 0;">
274-
<img src="https://github.com/Summage.png?size=64" width="64" height="64" alt="Summage" style="display: block; margin: 0 auto 8px; border-radius: 50%;" />
275-
<div style="font-size: 0.95rem; font-weight: 600; line-height: 1.25;">Summage</div>
276-
<div style="font-size: 0.8rem; line-height: 1.35;">初始 KV 架构设计优化</div>
277-
</a>
278-
</div>
242+
<p>
243+
<a href="https://github.com/yxrxy"><img src="https://wsrv.nl/?url=github.com/yxrxy.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="yxrxy" /></a>
244+
<a href="https://github.com/zTz01"><img src="https://wsrv.nl/?url=github.com/zTz01.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="zTz01" /></a>
245+
<a href="https://github.com/pakkah"><img src="https://wsrv.nl/?url=github.com/pakkah.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="pakkah" /></a>
246+
<a href="https://github.com/unity1263"><img src="https://wsrv.nl/?url=github.com/unity1263.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="unity1263" /></a>
247+
<a href="https://github.com/mumupika"><img src="https://wsrv.nl/?url=github.com/mumupika.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="mumupika" /></a>
248+
<a href="https://github.com/maplestarplayl"><img src="https://wsrv.nl/?url=github.com/maplestarplayl.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="maplestarplayl" /></a>
249+
<a href="https://github.com/RuileLu"><img src="https://wsrv.nl/?url=github.com/RuileLu.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="RuileLu" /></a>
250+
<a href="https://github.com/Summage"><img src="https://wsrv.nl/?url=github.com/Summage.png%3Fsize%3D64&amp;mask=circle&amp;w=64&amp;h=64&amp;fit=cover&amp;output=png" width="64" height="64" alt="Summage" /></a>
251+
</p>
252+
253+
- `yxrxy`: FluxonFS 实现和优化
254+
- `zTz01`: KVCache 优化
255+
- `pakkah`: RDMA 支持、VLM 探索
256+
- `unity1263`: KV共享内存设计接入、benchmark工具链
257+
- `mumupika`: 初始 MQ 版本实现
258+
- `maplestarplayl`: IPC 接入、SPDK 接入
259+
- `RuileLu`: KV lease 功能支持
260+
- `Summage`: 初始 KV 架构设计优化
279261

280262
## 许可证
281263

scripts/build_doc_site.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,31 @@
8686
border-color: var(--secondary);
8787
color: var(--light);
8888
}
89+
90+
/* Keep the inline GitHub repository icon aligned with text in the homepage link row. */
91+
a[href="https://github.com/Tele-AI/fluxon"] {
92+
display: inline-flex;
93+
align-items: center;
94+
vertical-align: middle;
95+
}
96+
97+
a[href="https://github.com/Tele-AI/fluxon"] > img[alt="GitHub repository"] {
98+
display: inline-block;
99+
margin: 0 !important;
100+
border-radius: 0;
101+
vertical-align: middle;
102+
}
103+
104+
a[href="https://github.com/Tele-AI/fluxon"] > svg[aria-label="GitHub repository"] {
105+
display: inline-block;
106+
position: relative;
107+
top: -2px;
108+
vertical-align: middle;
109+
}
110+
111+
a[href="https://github.com/Tele-AI/fluxon"] > .external-icon {
112+
display: none;
113+
}
89114
"""
90115
)
91116
QUARTZ_REPO_URL = "https://github.com/jackyzha0/quartz.git"

0 commit comments

Comments
 (0)