Skip to content

Commit 4ff3891

Browse files
Feat/contributor list (#14)
* feat: contributor ready * optimize: optimize the index page and cache file size
1 parent ecfe4c7 commit 4ff3891

95 files changed

Lines changed: 1338 additions & 465 deletions

File tree

Some content is hidden

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

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,30 @@ pnpm dev
147147
2. CI 检查必须通过(markdown lint、链接检查)
148148
3. 审核通过后,维护者将合并代码
149149

150+
## 非代码贡献
151+
152+
我们同样重视非代码形式的贡献!以下贡献方式均会被记录在 [CONTRIBUTORS.md](./CONTRIBUTORS.md) 中:
153+
154+
| 贡献类型 | 说明 | 如何参与 |
155+
|---------|------|---------|
156+
| 界面设计 | 文档站 UI/UX 优化 | 通过 Issue 提交设计方案 |
157+
| 插画配图 | 教程插图、架构图 | 通过 Issue 或邮件提交 |
158+
| 问题反馈 | 发现错误或不准确之处 | 提交 Issue 或通过微信/QQ/邮件反馈 |
159+
| 内容建议 | 新主题建议、改进意见 | 提交 Issue 或通过微信/QQ/邮件反馈 |
160+
| 内容审阅 | 技术校对、审阅 | 通过 Issue 或邮件参与 |
161+
| 翻译 | 英文翻译 | 通过 PR 提交 |
162+
163+
### 匿名贡献
164+
165+
如果您希望匿名贡献,请在反馈时注明。我们会使用化名或不具名记录您的贡献。
166+
167+
### 贡献者记录
168+
169+
所有贡献者会被记录在:
170+
171+
- [CONTRIBUTORS.md](./CONTRIBUTORS.md) — 完整贡献者列表
172+
- [文档站贡献者页面](https://awesome-embedded-learning-studio.github.io/Tutorial_AwesomeModernCPP/team/) — 在线展示
173+
150174
## 行为准则
151175

152176
- 尊重所有贡献者

CONTRIBUTORS.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# 贡献者
2+
3+
感谢所有为本项目做出贡献的人!
4+
5+
## 贡献类型说明
6+
7+
| 图标 | 类型 | 说明 |
8+
|:----:|------|------|
9+
| 🎨 | 界面设计 | UI/UX 设计、视觉优化 |
10+
| 🖼️ | 插画/配图 | 教程插图、架构图、流程图 |
11+
| 🐛 | 问题反馈 | 通过 Issue、微信、QQ、邮件等渠道反馈错误 |
12+
| 📝 | 内容建议 | 提供内容改进建议、学习路径优化 |
13+
| 🔍 | 审阅 | 内容审阅、技术校对 |
14+
| 🌍 | 翻译 | 英文翻译或其他语言翻译 |
15+
| 💡 | 示例代码 | 提供代码示例或改进建议 |
16+
| 📢 | 推广宣传 | 帮助传播项目 |
17+
18+
## 贡献者列表
19+
20+
<!--
21+
添加新贡献者时,请复制以下模板并填写:
22+
23+
### [贡献者名称或化名]
24+
25+
**贡献类型**:图标列表(如 🎨 🖼️)
26+
**贡献渠道**:GitHub / 微信 / QQ / 邮件 / 其他
27+
**贡献说明**:简要描述贡献内容
28+
29+
如果贡献者希望匿名,名称字段填写化名,不需要提供联系方式。
30+
-->
31+
32+
### Charliechen
33+
34+
**贡献类型**:📝 🔍 💡
35+
**贡献渠道**:GitHub
36+
**贡献说明**:项目维护者,教程主要作者
37+
38+
<!-- 在此处添加更多贡献者 -->
39+
40+
### [Doll-Attire](https://github.com/Doll-Attire)
41+
42+
**贡献类型**:🎨 📝
43+
**贡献渠道**:微信
44+
**贡献说明**:指导文档站 UI 设计,提供阅读体验改进意见

README.en.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,21 @@ If you have questions, feel free to open an issue at [GitHub Issues](https://git
191191

192192
---
193193

194+
## Contributors
195+
196+
Thanks to everyone who has contributed to this project! See [CONTRIBUTORS.md](./CONTRIBUTORS.md) for details.
197+
198+
<!-- ALL_CONTRIBUTORS_START -->
199+
| Contributor | Contributions |
200+
|-------------|--------------|
201+
| [Charliechen](https://github.com/Charliechen114514) | 📝 Content · 🔍 Review · 💡 Examples |
202+
| [Doll-Attire](https://github.com/Doll-Attire) | 🎨 UI Design · 📝 UX Improvements |
203+
<!-- ALL_CONTRIBUTORS_END -->
204+
205+
> Contributions are not limited to code — UI design, illustrations, issue reports, and content suggestions all count. See [CONTRIBUTING.md](./CONTRIBUTING.md).
206+
207+
---
208+
194209
## Acknowledgements
195210

196211
This project references the following excellent resources:

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,21 @@ Tutorial_AwesomeModernCPP/
195195

196196
---
197197

198+
## 贡献者
199+
200+
感谢所有为本项目做出贡献的人!详见 [CONTRIBUTORS.md](./CONTRIBUTORS.md)
201+
202+
<!-- ALL_CONTRIBUTORS_START -->
203+
| 贡献者 | 贡献类型 |
204+
|--------|---------|
205+
| [Charliechen](https://github.com/Charliechen114514) | 📝 内容 · 🔍 审阅 · 💡 示例 |
206+
| [Doll-Attire](https://github.com/Doll-Attire) | 🎨 界面设计 · 📝 体验改进 |
207+
<!-- ALL_CONTRIBUTORS_END -->
208+
209+
> 贡献方式不限于代码,包括界面设计、插画、问题反馈、内容建议等。详见 [CONTRIBUTING.md](./CONTRIBUTING.md)
210+
211+
---
212+
198213
## 致谢
199214

200215
本项目参考了以下优秀资源:

documents/appendix/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,8 @@ description: "辅助参考内容与术语表"
99

1010
## 参考资料
1111

12-
- [术语表](terminology/) — 中英文技术术语标准翻译对照表
12+
<ChapterNav variant="sub">
13+
<ChapterLink href="terminology/">术语表</ChapterLink>
14+
</ChapterNav>
15+
16+
中英文技术术语标准翻译对照表

documents/compilation/index.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@ tags:
1818

1919
## 章节导航
2020

21-
- [01 编译与链接概述](01-compilation-and-linking-overview.md)
22-
- [02 复用的概念](02-reuse-concept.md)
23-
- [03 创建和使用静态库](03-creating-and-using-static-libs.md)
24-
- [04 动态库(上)](04-dynamic-libraries-1.md)
25-
- [05 动态库设计](05-dynamic-library-design.md)
26-
- [06 符号可见性](06-symbol-visibility.md)
27-
- [07 符号缺失与运行时加载](07-symbol-missing-and-runtime-loading.md)
28-
- [08 库搜索逻辑](08-library-search-logic.md)
29-
- [09 动态库细节](09-dynamic-library-details.md)
30-
- [10 动态库作为可执行文件](10-dynamic-lib-as-executable.md)
21+
<ChapterNav>
22+
<ChapterLink num="1" href="01-compilation-and-linking-overview.md">编译与链接概述</ChapterLink>
23+
<ChapterLink num="2" href="02-reuse-concept.md">复用的概念</ChapterLink>
24+
<ChapterLink num="3" href="03-creating-and-using-static-libs.md">创建和使用静态库</ChapterLink>
25+
<ChapterLink num="4" href="04-dynamic-libraries-1.md">动态库(上)</ChapterLink>
26+
<ChapterLink num="5" href="05-dynamic-library-design.md">动态库设计</ChapterLink>
27+
<ChapterLink num="6" href="06-symbol-visibility.md">符号可见性</ChapterLink>
28+
<ChapterLink num="7" href="07-symbol-missing-and-runtime-loading.md">符号缺失与运行时加载</ChapterLink>
29+
<ChapterLink num="8" href="08-library-search-logic.md">库搜索逻辑</ChapterLink>
30+
<ChapterLink num="9" href="09-dynamic-library-details.md">动态库细节</ChapterLink>
31+
<ChapterLink num="10" href="10-dynamic-lib-as-executable.md">动态库作为可执行文件</ChapterLink>
32+
</ChapterNav>

documents/cpp-reference/concurrency/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ tags:
1111

1212
# 并发参考卡
1313

14-
- [std::atomic](01-atomic.md)
15-
- [std::thread](02-thread.md)
16-
- [std::mutex](03-mutex.md)
14+
<ChapterNav variant="sub">
15+
<ChapterLink href="01-atomic">std::atomic</ChapterLink>
16+
<ChapterLink href="02-thread">std::thread</ChapterLink>
17+
<ChapterLink href="03-mutex">std::mutex</ChapterLink>
18+
</ChapterNav>

documents/cpp-reference/containers/index.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ tags:
1111

1212
# 容器与视图参考卡
1313

14-
- [std::span](01-span.md)
15-
- [std::string_view](02-string-view.md)
16-
- [std::variant](03-variant.md)
17-
- [std::array](04-array.md)
18-
- [std::initializer_list](05-initializer-list.md)
14+
<ChapterNav variant="sub">
15+
<ChapterLink href="01-span">std::span</ChapterLink>
16+
<ChapterLink href="02-string-view">std::string_view</ChapterLink>
17+
<ChapterLink href="03-variant">std::variant</ChapterLink>
18+
<ChapterLink href="04-array">std::array</ChapterLink>
19+
<ChapterLink href="05-initializer-list">std::initializer_list</ChapterLink>
20+
</ChapterNav>

documents/cpp-reference/core-language/index.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ tags:
1010

1111
# 核心语言特性参考卡
1212

13-
- [constexpr / consteval / constinit](01-constexpr.md)
14-
- [lambda 表达式](02-lambda.md)
15-
- [auto / decltype](03-auto-decltype.md)
16-
- [nullptr](04-nullptr.md)
17-
- [enum class](05-enum-class.md)
18-
- [override 说明符](06-override-final.md)
19-
- [范围 for 循环](07-range-for.md)
20-
- [std::move](08-move-forward.md)
21-
- [泛型 Lambda](09-generic-lambda.md)
22-
- [std::exchange](10-exchange.md)
13+
<ChapterNav variant="sub">
14+
<ChapterLink href="01-constexpr">constexpr / consteval / constinit</ChapterLink>
15+
<ChapterLink href="02-lambda">lambda 表达式</ChapterLink>
16+
<ChapterLink href="03-auto-decltype">auto / decltype</ChapterLink>
17+
<ChapterLink href="04-nullptr">nullptr</ChapterLink>
18+
<ChapterLink href="05-enum-class">enum class</ChapterLink>
19+
<ChapterLink href="06-override-final">override 说明符</ChapterLink>
20+
<ChapterLink href="07-range-for">范围 for 循环</ChapterLink>
21+
<ChapterLink href="08-move-forward">std::move</ChapterLink>
22+
<ChapterLink href="09-generic-lambda">泛型 Lambda</ChapterLink>
23+
<ChapterLink href="10-exchange">std::exchange</ChapterLink>
24+
</ChapterNav>

documents/cpp-reference/memory/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ tags:
1111

1212
# 内存管理参考卡
1313

14-
- [std::unique_ptr](01-unique-ptr.md)
15-
- [std::shared_ptr](02-shared-ptr.md)
16-
- [std::optional](03-optional.md)
17-
- [std::make_unique](04-make-unique.md)
14+
<ChapterNav variant="sub">
15+
<ChapterLink href="01-unique-ptr">std::unique_ptr</ChapterLink>
16+
<ChapterLink href="02-shared-ptr">std::shared_ptr</ChapterLink>
17+
<ChapterLink href="03-optional">std::optional</ChapterLink>
18+
<ChapterLink href="04-make-unique">std::make_unique</ChapterLink>
19+
</ChapterNav>

0 commit comments

Comments
 (0)