Congratulations!
在编写 Docusaurus 教程或 Python 实训文档时,合理使用 Emoji 和 Markdown 符号 能显著提升文档的可读性和“活泼感”。
以下我为你整理了适合在 IT 教学、SOP 手册、以及代码练习中使用的所有高频符号,按场景进行了分类:
1. 📖 教学结构类
(用于标题和列表)
这些符号适合放在 ### 标题前面,增加视觉引导。
| 符号 | 建议场景 | 示例 |
|---|---|---|
| 🐍 | Python 相关 | ## 🐍 Python 基础 |
| 📖 | 理论知识/导读 | ### 📖 什么是变量 |
| 🛠️ | 环境搭建/工具配置 | ### 🛠️ VS Code 配置 |
| 💻 | 代码实战/练习题 | ### 💻 猜拳游戏练习 |
| 📝 | 笔记/作业 | ### 📝 课后作业 |
| 🌟 | 重点/核心概念 | ### 🌟 循环语句 (重点) |
| 🏁 | 课程结束/阶段目标 | ## 🏁 阶段实训总结 |
2. 💡 交互与贴士类
(配合 Admonitions 使用)
Docusaurus 的 :::tip 等容器非常适合搭配这些图标。
- ✨ 技巧 (Tip):
:::tip ✨ 快捷键技巧 - 💡 启发 (Idea):
:::info 💡 想想看,如果 a = a + 1 会怎样? - ⚠️ 警告 (Warning):
:::warning ⚠️ 注意:不要在变量名开头用数字 - 🚨/❌ 报错 (Error):
:::danger 🚨 常见报错:SyntaxError - 🔍 深入探索:用于讲解底层原理(如 Python 内存管理)。
- 🙋 常见问题 (FAQ):用于列出学生经常问错的地方。
3. ⌨️ 编程逻辑类
(用于代码注释和说明)
在 .py 文件或代码块中使用,比纯文字更有趣。
- 输入/输出:📥 (Input) / 📤 (Output) / 🖨️ (Print)
- 逻辑流:➡️ (下一步) / 🔄 (循环) / 🔀 (分支 if-else)
- 正确/错误:✅ (Pass) / ❌ (Fail) / 🚩 (标记/断点)
- 时间/效率:⏱️ (代码运行耗时) / 🚀 (性能优化)
- 数据库/存储:🗄️ (SQLite) / 💾 (保存数据)
4. 📂 目录结构常用字符
如果你在文档中展示文件树,使用这些 Unicode 字符比 Emoji 更专业:
└─ 📂 project-root
├─ 📄 app.py
├─ 📂 templates
│ └─ 📄 index.html
└─ ⚙️ config.ini
└─: 最后一项├─: 中间项│: 垂直连线
5. 🎨 活泼装饰类
(用于增加趣味性) 适合在“数字化教学质量监测中心”这类前台页面使用。
- 🎉 庆祝:任务完成时。
- 🎯 目标:今日实训目标。
- 🎓 毕业/通过:考试/复试通过。
- 👨🏫 老师说:放置你的专业点评。
- 👶 新手友好:标注简单的练习。
- 🔥 热门/高频:哈工大复试常考题。
6. ✨其他符号图标
- ** Admonitions 提示块**:使用了
:::info,:::tip,:::warning,:::danger来区分导读、贴士、警告和必背知识点,界面颜色更丰富,重点更突出。 - 🐍, 📝, 🚀, 🛠️, 💡, 🐥, 🤓, ⚠️, ✨, 🎒
🛠️ 如何在 VS Code 中快速输入?
- Windows: 按下
Win+.(句号) 即可弹出 Emoji 选择框。 - Mac: 按下
Command+Control+Space。