登录
注册
开源
企业版
高校版
搜索
帮助中心
使用条款
关于我们
开源
企业版
高校版
私有云
模力方舟
登录
注册
代码拉取完成,页面将自动刷新
捐赠
捐赠前请先登录
取消
前往登录
扫描微信二维码支付
取消
支付完成
支付提示
将跳转至支付宝完成支付
确定
取消
Watch
不关注
关注所有动态
仅关注版本发行动态
关注但不提醒动态
5
Star
1
Fork
5
精益开源
/
APP-DEV
代码
Issues
0
Pull Requests
0
Wiki
统计
流水线
服务
质量分析
Jenkins for Gitee
腾讯云托管
腾讯云 Serverless
悬镜安全
阿里云 SAE
Codeblitz
SBOM
我知道了,不再自动展开
更新失败,请稍后重试!
移除标识
内容风险标识
本任务被
标识为内容中包含有代码安全 Bug 、隐私泄露等敏感信息,仓库外成员不可访问
MD文件部署规范
已完成
#I4Q2L8
aeye
成员
创建于
2022-01-10 11:21
### 为提高开发者的使用体验,需要建立统一的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等也一并放入本课程目录。 ### 欢迎大家集思广益,达成共识
### 为提高开发者的使用体验,需要建立统一的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等也一并放入本课程目录。 ### 欢迎大家集思广益,达成共识
评论 (
1
)
登录
后才可以发表评论
状态
已完成
待办的
进行中
已完成
已关闭
负责人
未设置
标签
未设置
标签管理
里程碑
未关联里程碑
未关联里程碑
Pull Requests
未关联
未关联
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
未关联
未关联
master
develop
开始日期   -   截止日期
-
置顶选项
不置顶
置顶等级:高
置顶等级:中
置顶等级:低
优先级
不指定
严重
主要
次要
不重要
参与者(1)
其他
1
https://gitee.com/openatom-university/app-dev.git
git@gitee.com:openatom-university/app-dev.git
openatom-university
app-dev
APP-DEV
点此查找更多帮助
搜索帮助
Git 命令在线学习
如何在 Gitee 导入 GitHub 仓库
Git 仓库基础操作
企业版和社区版功能对比
SSH 公钥设置
如何处理代码冲突
仓库体积过大,如何减小?
如何找回被删除的仓库数据
Gitee 产品配额说明
GitHub仓库快速导入Gitee及同步更新
什么是 Release(发行版)
将 PHP 项目自动发布到 packagist.org
评论
仓库举报
回到顶部
登录提示
该操作需登录 Gitee 帐号,请先登录后再操作。
立即登录
没有帐号,去注册