diff --git a/README.md b/README.md index e47437d..0c2fd15 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Rust for QEMU Insides 是华中科技大学开放原子开源俱乐部发起的 ​ - 文档补充:完善 QEMU 某模块的原理解析、补充 Rust 实践案例。​ -- 代码优化:改进示例代码性能、修复 Bug、新增实用工具。​ +- 代码优化:改进示例代码、修复 Bug、新增实用工具。​ - 需求反馈:通过 Issue 提出文档漏洞、功能需求。 @@ -32,18 +32,10 @@ Rust for QEMU Insides 是华中科技大学开放原子开源俱乐部发起的 - 社群支持:[华科开放原子开源俱乐部 QQ 群](https://qm.qq.com/q/2uEd11lkWk) -- 俱乐部官网:https://hust.openatom.club/ +- 俱乐部官网:[HUST OpenAtom Open Source Club](https://hust.openatom.club/) ## 许可证​ - 文档部分(docs/ 目录):采用 CC BY-SA 4.0 国际许可证(可共享、修改,需注明出处且以相同许可证分发)。​ - 代码部分(examples/、scripts/ 目录):采用 MIT 许可证(可自由使用、修改、分发,需保留版权声明)。​ - -## 致谢​ - -- 感谢 QEMU 开源社区提供的虚拟化技术基础与文档支持。​ - -- 感谢 Rust 社区为内存安全编程提供的技术生态。​ - -- 感谢华中科技大学对开源俱乐部对本项目的指导与支持。 diff --git a/docs/index.md b/docs/index.md index e9d0356..9a2c39c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,38 +4,39 @@ Rust for QEMU Insides 是华中科技大学开放原子开源俱乐部发起的 无论是虚拟化领域初学者、Rust 技术实践者,还是开源爱好者,都能从本项目中获取 QEMU 底层原理的清晰解读与 Rust 落地实践的参考案例。 -## 项目背景 +!!! example "项目背景" -- QEMU 的技术价值:QEMU 是开源虚拟化领域的核心工具,支持多架构硬件模拟、全系统虚拟化,但其核心代码基于 C 语言开发,存在内存安全、并发控制等工程挑战。​ + - QEMU 的技术价值:QEMU 是开源虚拟化领域的核心工具,支持多架构硬件模拟、全系统虚拟化,但其核心代码基于 C 语言开发,存在内存安全、并发控制等工程挑战。​ -- Rust 的优势适配:Rust 语言的内存安全、零成本抽象、高效并发特性,可针对性解决 QEMU 开发中的痛点,为 QEMU 模块扩展、性能优化提供新方向。​ + - Rust 的优势适配:Rust 语言的内存安全、零成本抽象、高效并发特性,可针对性解决 QEMU 开发中的痛点,为 QEMU 模块扩展、性能优化提供新方向。​ -- 社区与学习需求:当前开源社区中,“Rust + QEMU”深度结合的系统性文档较少,本项目旨在填补这一空白,同时为社区提供技术实践与开源协作的平台。 + - 社区与学习需求:当前开源社区中,“Rust + QEMU”深度结合的系统性文档较少,本项目旨在填补这一空白,同时为社区提供技术实践与开源协作的平台。 -## 贡献指南​ +!!! question "贡献指南​" -本项目欢迎华科开放原子开源俱乐部成员及全球开源开发者参与贡献,贡献方向包括: -​ -- 文档补充:完善 QEMU 某模块的原理解析、补充 Rust 实践案例。​ + 本项目欢迎华科开放原子开源俱乐部成员及全球开源开发者参与贡献,贡献方向包括: -- 代码优化:改进示例代码性能、修复 Bug、新增实用工具。​ + - 文档补充:完善 QEMU 某模块的原理解析、补充 Rust 实践案例。​ -- 需求反馈:通过 Issue 提出文档漏洞、功能需求。 + - 代码优化:改进示例代码、修复 Bug、新增实用工具。​ -具体贡献流程以及规范,请查阅 [CONTRIBUTING.md](CONTRIBUTING.md) + - 需求反馈:通过 Issue 提出文档漏洞、功能需求。 -## 维护团队​ + 具体贡献流程以及规范,请查阅 [CONTRIBUTING.md][contributing] -- 发起组织:[华中科技大学开放原子开源俱乐部​](https://github.com/hust-open-atom-club) +!!! tip "维护团队​" -- 核心维护团队:俱乐部 Rust for Linux/QEMU 项目组 + - 发起组织:[华中科技大学开放原子开源俱乐部​](https://github.com/hust-open-atom-club) -- 社群支持:[华科开放原子开源俱乐部 QQ 群](https://qm.qq.com/q/2uEd11lkWk) + - 核心维护团队:俱乐部 Rust for Linux/QEMU 项目组 -- 俱乐部官网:https://hust.openatom.club/ + - 社群支持:[华科开放原子开源俱乐部 QQ 群](https://qm.qq.com/q/2uEd11lkWk) -## 许可证​ + - 俱乐部官网:[HUST OpenAtom Open Source Club](https://hust.openatom.club/) -> - 文档部分(docs/ 目录):采用 CC BY-SA 4.0 国际许可证(可共享、修改,需注明出处且以相同许可证分发)。​ -> -> - 代码部分(examples/、scripts/ 目录):采用 MIT 许可证(可自由使用、修改、分发,需保留版权声明)。​ \ No newline at end of file + +!!! note "许可证" + - 文档部分(docs/ 目录):采用 CC BY-SA 4.0 国际许可证(可共享、修改,需注明出处且以相同许可证分发)。​ + - 代码部分(examples/、scripts/ 目录):采用 MIT 许可证(可自由使用、修改、分发,需保留版权声明)。​ + +[contributing]: https://github.com/hust-open-atom-club/rust-for-qemu-insides/blob/main/CONTRIBUTING.md \ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..3457924 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,5 @@ +/* 全局段落两端对齐 */ +article p { + text-align: justify; + text-justify: inter-word; +} diff --git a/mkdocs.yml b/mkdocs.yml index 64cc475..436f2f1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -56,7 +56,6 @@ theme: icon: material/weather-sunny name: Switch to happy mode accent: pink - # Palette toggle for dark mode - media: "(prefers-color-scheme: dark)" scheme: slate @@ -65,7 +64,6 @@ theme: name: Switch to light mode primary: blue grey accent: pink - features: - content.code.copy - content.tooltips @@ -79,7 +77,9 @@ theme: - search.highlight - search.share - header.autohide - +extra_css: + - stylesheets/extra.css + nav: - 主页: index.md - 文档: articles/index.md