CodingTrain网站归档项目页面贡献指南解析

CodingTrain网站归档项目页面贡献指南解析

website-archive Archive of the Coding Train website (first version) 项目地址: https://gitcode.com/gh_mirrors/we/website-archive

前言

CodingTrain网站归档项目是一个技术教育资源平台，主要为编程教学视频提供配套的网页支持。本文将详细介绍如何为该项目创建和更新页面内容，帮助技术爱好者更好地参与项目维护。

项目背景与意义

CodingTrain网站作为编程教学视频的配套平台，需要为每个视频创建专门的页面。这些页面包含视频元数据、相关代码资源和学习资料链接，是学习者获取完整学习体验的重要渠道。

准备工作

在开始创建或修改页面前，建议先确认以下几点：

1. 检查页面是否已存在或正在被他人编辑
2. 确定页面的正确存放位置
3. 准备视频相关的所有素材和资料

页面存放规范

目录结构

页面存放在以下结构的目录中：

_分类目录/子目录/视频编号-标题.md

例如，p5.js基础教程中关于随机函数的视频页面路径为：

_beginners/p5js/2.5-random.md

命名规则

1. 主目录以"_"开头（Jekyll静态网站生成器的要求）
2. 文件名格式：视频编号-标题（使用连字符而非空格）
3. 避免使用特殊字符和空格

新建目录注意事项

创建新目录时，需要同时创建index.md文件作为目录索引页，示例内容如下：

---
title: 系列或章节标题
layout: series-index
redirect_from:
  - /短链接示例
---

<!-- 系列描述内容 -->

页面内容规范

YAML头部信息

每个页面以YAML格式的元数据开头，包含以下关键字段：

---
title: 视频标题（不含系列名）
video_number: 视频编号（如2.5）
date: 发布日期（YYYY-MM-DD格式）
video_id: YouTube视频ID
repository: 代码仓库路径
web_editor: p5.js在线编辑器ID
can_contribute: 是否允许贡献（布尔值）
remake: 重制版视频路径
redirect_from: 原页面路径（如有迁移）
variations: 代码变体信息
links: 相关资源链接
videos: 相关视频信息
---

页面正文内容

正文部分应包含：

1. 视频简介（1-2句话）
2. 详细说明（可选）
3. 学习要点（可选）

代码资源管理

代码存放位置

代码资源存放在与页面对应的非下划线开头的目录中，例如：

beginners/p5js/2.5-random/P5

代码目录命名规范

不同编程语言的默认目录名：

• p5.js: P5
• Processing: Processing
• JavaScript: JavaScript
• Node.js: Node

代码来源

代码可从以下位置获取：

1. YouTube视频描述
2. 在线编辑器
3. 代码仓库
4. 视频中展示的代码（如无其他来源）

质量保证

提交前建议进行以下检查：

1. 运行单元测试：

cd unit-testing
npm install
npm test

2. 执行代码风格检查：

npm install
npm run lint

常见问题解答

Q: 为什么文件名要用连字符而不是空格？ A: 不同操作系统对空格的处理方式不同，使用连字符可避免兼容性问题。

Q: 如何确定视频编号？ A: 编号通常与视频在系列中的顺序一致，可参考YouTube播放列表中的顺序。

Q: 找不到视频代码怎么办？ A: 可以先创建页面但不包含代码部分，或在讨论区询问其他贡献者。

结语

通过遵循本指南，您可以高效地为CodingTrain网站创建和维护内容页面。规范的页面结构不仅便于维护，也能为学习者提供一致的浏览体验。如有任何疑问，欢迎与项目维护团队交流。

website-archive Archive of the Coding Train website (first version) 项目地址: https://gitcode.com/gh_mirrors/we/website-archive