MD文件部署规范

### 为提高开发者的使用体验，需要建立统一的MD文件部署规范

1.充分利用Gitee的自动化功能，Gitee会自动打开目录下的ReadMe.MD文件。所以我建议，所有课程都建立一个目录，目录名为课程名称，原来的课程MD文件命名为ReadMe.MD。如果是中英双语的课程，应该在更高级父目录上分为中英文文档，英文课程也如法炮制。

2.多媒体文件部署策略。MD文件中可能会使用图片、视频、音频等多媒体信息，由于Gitee的存储容量限制，视频和音频可以存储到B站、喜马拉雅等专业云服务平台，MD文档中只使用超链接。图片可以存储在Gitee上，根据规范1带来的红利，建议在课程目录中建立Images目录存储MD文档中对应的图片文件。与使用一个高级别目录存储相比，带来的好处是，当课程名称发生变化或移动存储位置或平台迁移，MD文件中的多媒体文件引用路径均无需修改。

3.MD文件中的图片文件引用路径应使用相对路径，这样本地MD文件和云端MD文件可保持一致，大大降低维护成本。

4.与本课程相关的其他文件，如samples等也一并放入本课程目录。

### 欢迎大家集思广益，达成共识

精益开源/APP-DEV

内容风险标识

评论 (1)