Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
ee398b5
refactor(config): 抽 shared.ts 单一真相源,根治三处 defineConfig 漂移
Charliechen114514 Jun 22, 2026
5d4ab81
ci: 升级 deploy.yml + 新增 build-check / lint 检查门
Charliechen114514 Jun 22, 2026
37fb7a5
chore: 加 markdownlint + pre-commit + editorconfig 自检三件套
Charliechen114514 Jun 22, 2026
11537a1
style: 清理 markdownlint 全量存量违规,lint 门转强制拦截
Charliechen114514 Jun 22, 2026
965d05a
docs(readme): 开篇改为严肃的一句话定位,去掉故事性叙事
Charliechen114514 Jun 22, 2026
4fedf3b
docs(readme): 文末改为严肃的导航语
Charliechen114514 Jun 22, 2026
2582649
docs: 加贡献者入口 CONTRIBUTING + AGENTS + Issue/PR 模板
Charliechen114514 Jun 22, 2026
cc9f7d2
feat(ci): 内链检查门 + 专家层源码引用验真
Charliechen114514 Jun 22, 2026
348a546
feat(ci): 示例编译门 build_examples.py + build-examples.yml
Charliechen114514 Jun 22, 2026
4f9659f
fix(site): 修 favicon 404,用 Awesome-Embedded.ico 作站点图标
Charliechen114514 Jun 22, 2026
787729f
feat(site): 生成 sitemap.xml + robots.txt 供搜索引擎收录
Charliechen114514 Jun 22, 2026
d864d8c
chore: third_party submodule 钉到 release tag(benchmark v1.9.5 / google…
Charliechen114514 Jun 22, 2026
6dfd09c
docs: 加 License NOTICE(代码 MIT / 文档 CC BY-SA 4.0 / Qt 源码引用按 Qt 许可)
Charliechen114514 Jun 22, 2026
83236be
feat(site): 对齐 tamcpp 4 个站点体验功能(代码折叠/字号切换/快捷键/页脚版本)
Charliechen114514 Jun 22, 2026
2e8c1e8
feat(site): 首页轮播图 HomeCarousel(占位骨架,图就位自动替换)
Charliechen114514 Jun 22, 2026
2b0df84
feat(carousel): 控件 demo 改用动图(.gif),静态页面留 .png
Charliechen114514 Jun 22, 2026
4a23a10
feat(carousel): 接入真实轮播素材(2 动图 WebP + 2 静态 WebP)
Charliechen114514 Jun 22, 2026
0dfc4bc
refactor(carousel): 照搬 tamcpp ScreenshotCarousel(3D coverflow)替换自造 Ho…
Charliechen114514 Jun 22, 2026
924e8bb
trigger ci
Charliechen114514 Jun 22, 2026
2c19bf4
fix(ci): build-examples 改用 install-qt-action 装 Qt6 全套模块(apt 缺包)
Charliechen114514 Jun 22, 2026
cc8c9ec
ci: fix
Charliechen114514 Jun 23, 2026
b4d97c2
fix ci
Charliechen114514 Jun 23, 2026
84a7362
fix ci
Charliechen114514 Jun 23, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
max_line = off

[*.{yml,yaml}]
indent_style = space
indent_size = 2
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: "贡献指南 / Contributing Guide"
url: "https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeQt/blob/main/CONTRIBUTING.md"
about: "查看文章五段结构、代码示例规范、本地预览和提交前检查。"
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/content-correction.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: "内容勘误 / Content Correction"
description: "报告错别字、概念错误、术语不准确、代码讲解问题、专家层源码引用过时。"
title: "[内容勘误] "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
感谢你帮助改进教程内容。请尽量给出具体页面、原文位置和判断依据,这会让维护者更快处理。

- type: input
id: location
attributes:
label: "相关页面或文件"
description: "请粘贴文档页面链接,或仓库中的文件路径。"
placeholder: "例如:tutorial/beginner/01-qtbase/01-signal-slot-beginner.md 或在线页面链接"
validations:
required: true

- type: dropdown
id: correction_type
attributes:
label: "问题类型"
multiple: true
options:
- "错别字 / 表达问题"
- "概念错误"
- "术语不准确"
- "代码讲解不准确"
- "专家层源码引用过时(文件:行号 对不上当前 Qt 源码)"
- "参考链接或引用问题"
- "其他"
validations:
required: true

- type: textarea
id: current_content
attributes:
label: "当前内容"
description: "请贴出有问题的原文、代码片段,或描述具体位置。"
placeholder: "例如:某节中写到“...”,但这里可能不准确。"
validations:
required: true

- type: textarea
id: problem
attributes:
label: "问题说明"
description: "请说明为什么这里不准确,或会造成什么误解。"
placeholder: "例如:Qt 6 中该 API 的行为应为 ...,当前说法不准确。"
validations:
required: true

- type: textarea
id: suggestion
attributes:
label: "建议修改"
description: "如果你已经有建议写法,可以贴在这里。"
placeholder: "建议改为:..."

- type: textarea
id: references
attributes:
label: "补充材料"
description: "可以附 Qt 官方文档、编译器输出、截图或其他参考资料。"
placeholder: "Qt 官方文档链接、截图、编译输出等。"
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/content-proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: "内容提案 / Content Proposal"
description: "建议新增文章、改进现有内容、补充示例或实例库组件。"
title: "[内容提案] "
labels: ["documentation", "enhancement"]
body:
- type: markdown
attributes:
value: |
这个入口适合讨论“要不要写、写到哪里、写到什么深度”。如果你已经有草稿,也可以在这里先说明主题。

- type: dropdown
id: proposal_type
attributes:
label: "提案类型"
multiple: true
options:
- "新增正式教程(入门/进阶/专家)"
- "改进现有文章"
- "新增代码示例(examples/)"
- "新增实例库组件(widget/app/model/industrial)"
- "其他"
validations:
required: true

- type: textarea
id: summary
attributes:
label: "主题简介"
description: "请用几句话说明你想新增或改进什么。"
placeholder: "例如:希望新增一篇关于 QProperty 绑定的进阶文章。"
validations:
required: true

- type: textarea
id: audience
attributes:
label: "目标读者"
description: "这篇内容适合哪些读者?"
placeholder: "例如:有 QtWidgets 基础、想理解信号槽底层实现的读者。"

- type: textarea
id: placement
attributes:
label: "建议放置位置"
description: "如果你知道,可以写对应层级、模块或目录;不确定可以写“不确定”。"
placeholder: "例如:进阶层 QtWidgets / 03-qtwidgets,或实例库 widget/。"

- type: textarea
id: outline
attributes:
label: "建议结构"
description: "可以简单列出文章大纲、示例安排或核心问题。"
placeholder: |
- 背景和动机
- 核心概念
- 示例代码
- 踩坑预防
- 参考资料

- type: textarea
id: references
attributes:
label: "参考资料"
description: "可以附 Qt 官方文档、书籍、博客、源码、Issue 等。"
placeholder: "链接或书目信息。"

- type: dropdown
id: submission_plan
attributes:
label: "你是否计划提交 PR"
options:
- "是,我准备投稿"
- "是,但需要先讨论方向"
- "暂时只是建议"
validations:
required: true
81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/example-build-problem.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: "示例或构建问题 / Example or Build Problem"
description: "报告代码示例无法编译、CMake 问题、工具链问题。"
title: "[构建问题] "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
感谢反馈代码或构建问题。请提供命令、错误输出和环境信息,方便维护者复现。

- type: input
id: target
attributes:
label: "相关示例或文件"
description: "请粘贴代码示例路径、章节链接或文件路径。"
placeholder: "例如:examples/beginner/01-qtbase/02-signal-slot-beginner/ 或 widget/status-led/"
validations:
required: true

- type: dropdown
id: problem_type
attributes:
label: "问题类型"
multiple: true
options:
- "示例代码无法编译"
- "CMake 配置问题"
- "工具链或编译器兼容问题"
- "实例库(widget/app/model/industrial)问题"
- "其他"
validations:
required: true

- type: textarea
id: command
attributes:
label: "你执行了什么命令"
description: "请贴出触发问题的命令。"
placeholder: "例如:cmake -B build && cmake --build build"
validations:
required: true

- type: textarea
id: error
attributes:
label: "错误输出"
description: "请粘贴关键错误信息。长日志可以只贴最相关部分。"
render: shell
validations:
required: true

- type: textarea
id: environment
attributes:
label: "环境信息"
description: "请填写与你的问题相关的环境。"
value: |
- 操作系统:Windows 10/11 / Linux / WSL2
- Qt 版本:6.x
- 编译器:MSVC 2019/2022 / MinGW 11.2+ / GCC 11+
- CMake 版本:≥ 3.26
- C++ 标准:17
validations:
required: true

- type: dropdown
id: pr_willingness
attributes:
label: "你是否愿意提交 PR 修复"
options:
- "愿意"
- "可能可以"
- "暂时不方便"
validations:
required: true

- type: textarea
id: extra
attributes:
label: "补充信息"
description: "可以附最小复现、相关截图、链接或你已经尝试过的修复方式。"
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/site-problem.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: "站点问题 / Site Problem"
description: "报告 404、搜索异常、页面显示错误、移动端排版、导航问题。"
title: "[站点问题] "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
感谢反馈站点体验问题。请尽量提供页面链接、复现步骤和截图,这会帮助我们快速定位。

- type: input
id: page
attributes:
label: "问题页面"
description: "请粘贴出现问题的页面链接。"
placeholder: "例如:https://awesome-embedded-learning-studio.github.io/Tutorial_AwesomeQt/..."
validations:
required: true

- type: dropdown
id: problem_type
attributes:
label: "问题类型"
multiple: true
options:
- "404 / 链接失效"
- "搜索问题"
- "页面渲染问题"
- "Mermaid / 代码块渲染异常"
- "移动端显示问题"
- "侧边栏 / 下一页导航问题"
- "其他"
validations:
required: true

- type: textarea
id: actual
attributes:
label: "实际表现"
description: "你看到了什么问题?"
placeholder: "例如:点击某个链接后进入 404;移动端代码块横向溢出。"
validations:
required: true

- type: textarea
id: expected
attributes:
label: "期望表现"
description: "你认为它应该如何显示或跳转?"
placeholder: "例如:应跳转到对应章节。"

- type: textarea
id: steps
attributes:
label: "复现步骤"
description: "如果问题可以稳定复现,请写出操作步骤。"
placeholder: |
1. 打开 ...
2. 点击 ...
3. 看到 ...

- type: textarea
id: environment
attributes:
label: "环境信息"
description: "如果是显示或搜索问题,请填写你使用的设备和浏览器。"
value: |
- 设备:桌面 / 手机 / 平板
- 浏览器:
- 操作系统:
- 是否使用深色模式:

- type: textarea
id: screenshots
attributes:
label: "截图"
description: "如果方便,请粘贴截图或录屏。"
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Pull Request Templates

本目录提供多个 PR 模板:

- `bugfix.md`:勘误、站点、示例/实例库代码、构建脚本、专家层源码引用修复。
- `article-submission.md`:正式教程投稿、实例库投稿。

GitHub 多 PR 模板通过 URL 参数选择:

```text
https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeQt/compare/main...BRANCH?template=bugfix.md
https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeQt/compare/main...BRANCH?template=article-submission.md
```

如果直接从 GitHub 默认入口创建 PR 没有选模板,可以手动复制对应模板内容。
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/article-submission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## 投稿类型

- [ ] 正式教程投稿(入门 / 进阶 / 专家)
- [ ] 实例库投稿(widget / app / model / industrial)
- [ ] 现有文章或实例改进
- [ ] 其他

> 最终放置位置(正式教程层级 / 实例库目录)由维护者判断。

## 内容说明

请简要说明这篇内容写了什么、面向哪些读者,以及为什么适合本项目。

## 作者与授权

- 作者署名:
- 是否原创:
- 是否允许维护者调整标题、格式、放置位置和部分措辞:
- 外部资料、图片、代码来源:

## 建议位置

-

## 检查项

- [ ] Markdown 可以正常阅读
- [ ] 引用外部资料时已提供来源
- [ ] 图片、代码或大段材料来源清楚
- [ ] 如包含代码,已说明是否测试过
- [ ] 如包含示例/实例库代码,`cmake -B build && cmake --build build` 通过
- [ ] 专家层投稿:源码引用已带「文件:行号」对齐当前 Qt 源码
- [ ] 如申请进入正式教程,已考虑是否需要更新导航或索引

## 关联 Issue

Close #
Loading
Loading