# Web3 入门教程文章模板使用指南

## 模板介绍

本仓库提供了一个统一的文章模板，用于创建高质量、风格一致的 Web3 教程内容。使用此模板可以确保所有的教程内容保持一致的格式和结构，提高阅读体验和知识传递效率。

## 模板文件

- [`article_template.md`](article_template.md) - 基础文章模板

## 如何使用模板

### 步骤 1: 复制模板

将 `article_template.md` 复制到您计划创建新文章的目录中，并根据文章内容重命名，通常使用 `README.MD` 作为文件名。

### 步骤 2: 填写基本信息

更新文章顶部的基本信息：

1. **文章标题**: 简洁明了，反映文章主要内容
2. **状态徽章**: 根据文章状态选择（进行中/已完成）
   - 进行中: `![status](https://img.shields.io/badge/状态-进行中-yellow)`
   - 已完成: `![status](https://img.shields.io/badge/状态-已完成-success)`
3. **作者徽章**: 填入您的名字
   - `![author](https://img.shields.io/badge/作者-您的名字-blue)`
4. **日期徽章**: 按 YYYY-MM 格式填写
   - `![date](https://img.shields.io/badge/日期-2025--06-orange)`
5. **难度徽章**: 根据内容难度选择
   - 初级: `![difficulty](https://img.shields.io/badge/难度-初级-brightgreen)`
   - 中级: `![difficulty](https://img.shields.io/badge/难度-中级-yellow)`
   - 高级: `![difficulty](https://img.shields.io/badge/难度-高级-red)`

### 步骤 3: 编写文章内容

1. **目录**: 根据实际文章结构更新目录链接
2. **前言**: 介绍文章背景、目的和读者将获得的知识
3. **主体内容**: 按逻辑顺序组织内容，使用二级和三级标题
4. **图片**: 所有图片应放在文章所在目录的 `img/` 子目录中，使用相对路径引用
   - 图片引用示例: `<div align="center"> <img src="./img/图片名称.jpg" width = 500 /> </div>`
5. **常见问题**: 针对主题添加常见问题和回答
6. **总结**: 概括文章要点，提供后续学习建议

### 步骤 4: 检查和完善

发布前请检查以下项目：

- [ ] 所有链接是否有效
- [ ] 图片是否正确显示
- [ ] 标题与内容是否一致
- [ ] 文本是否存在拼写或语法错误
- [ ] 页脚信息是否完整
- [ ] 目录链接是否正确

## 写作风格和原则

### 总体风格

1. **简单明了**: 使用简洁、直接的语言，避免复杂的句子结构和技术行话
2. **实用性先行**: 文章应偏向于实际操作指导，让读者能够“看完就会用”
3. **避免大段代码**: 当需要展示代码时，保持简短、清晰，并直接解释关键部分
4. **情感化的前言和总结**: 在前言中分享个人经历或激励读者的话语，在总结中引发读者的想象和兴趣
5. **生动具体**: 使用实际例子、类比和场景描述来让技术概念更易理解

### Markdown 格式

1. **标题层级**: 文章标题使用一级标题 `#`，主要章节使用二级标题 `##`，子章节使用三级标题 `###`
2. **强调**: 使用反引号 `` ` `` 突出显示代码、命令或专业术语
3. **列表**: 使用无序列表 `-` 或有序列表 `1.` 组织相关信息
4. **表格**: 使用 Markdown 表格呈现结构化数据，表头居中对齐
5. **引用**: 使用 `>` 标记引述内容或重要提示
6. **Emoji**: 适当使用 emoji 增强视觉效果和内容区分，如 💡 提示，⚠️ 警告，✅ 完成等

### 图片规范

1. **格式**: 优先使用 JPG 或 PNG 格式
2. **大小**: 优化图片大小，保持清晰度的同时控制文件大小
3. **命名**: 使用有意义的英文名称，使用下划线或连字符分隔词汇
4. **引用**: 统一使用 `<div align="center">` 标签居中显示图片
5. **尺寸控制**: 使用 `width = 500` 等方式控制图片大小

## 注意事项

1. 保持内容准确、简洁、专业
2. 避免过于技术性的术语，或在使用时提供解释
3. 文章长度适中，通常不超过 3000 字
4. 适当添加实例和练习，帮助读者应用所学知识
5. 确保页脚包含返回主页、关注作者和加入交流群的链接

## 示例文章

参考以下示例文章，了解模板的实际应用效果：

1. [创建你的第一个 Web3 身份](/01_Web3QuickStart/01_FirstWeb3Identity/README.MD)
2. [发行你的第一个代币](/01_Web3QuickStart/05_LaunchYourFirstToken/README.MD)
3. [为什么区块链是必须的？《主权个人》读书笔记](/Web3Thoughts/02_WhyBlockchainIsNecessary/README.MD)

希望此模板和指南对您创作高质量 Web3 教程内容有所帮助！
