文档/教程前端【免费下载链接】en.javascript.infoModern JavaScript Tutorial项目地址https://gitcode.com/gh_mirrors/en/en.javascript.info点击查看免费下载本指南基于 en.javascript.info 仓库《现代 JavaScript 教程》英文内容仓库的根级说明文档编写系统讲解该教程的内容组织方式、index.md/article.md/task.md三种材料类型的编写约定、任务与题解的配对规则以及如何为本仓库贡献新内容。读完本文你将掌握该教程仓库的目录命名规范、文档骨架格式与本地预览方式能够独立新增或修改一个章节、文章或任务。仓库是什么本仓库托管《现代 JavaScript 教程》Modern JavaScript Tutorial的英文内容即 javascript.info 明确说明仓库中的内容就是教程网站的原文来源教程最终在线呈现的内容即由本仓库驱动。《现代 JavaScript 教程》覆盖了从 JavaScript 语言基础到浏览器、网络、动画等主题的完整学习路径。以 1-js核心语言部分和 2-ui浏览器文档、事件与接口部分为例仓库按主题将全部材料划分为不同部分Part每个部分再由多个章节Chapter构成。仓库的内容结构约定README 给出了非常明确的目录组织规则每一个章节chapter、文章article或任务task都拥有独立的文件夹。例如核心语言部分的第一个章节就位于 1-js/01-getting-started/1-intro/。文件夹命名遵循N-url模式N是用于排序的编号保证各文件夹在目录中按教学顺序排列url是该材料标题对应的 URL 片段同时起到语义化命名的作用。例如 1-js/02-first-steps/01-hello-world/ 对应“Hello, world!”这篇文章01是排序编号hello-world是 URL 片段。在仓库中可以看到这种嵌套结构的多级体现部分级入口1-js/index.md、2-ui/index.md章节级入口1-js/01-getting-started/index.md文章级入口1-js/01-getting-started/1-intro/article.md任务级入口1-js/02-first-steps/01-hello-world/1-hello-alert/task.md。这种“编号 URL 片段”的命名模式使得整个教程的目录顺序即学习顺序同时每个文件夹的语义化名称也能直接映射到站点 URL。三种材料类型及其识别方式文件夹内部的文件类型决定了材料的性质。README 中明确了三种类型文件材料类型说明index.md章节chapter一个章节的入口通常只含简短引言article.md文章article一篇完整的教程正文task.md任务task一道练习题必须同时提供solution.md作为题解三个文件都以# Main header一级标题开头即每份材料的第一行都是 Markdown 的一级标题。在仓库中可以看到这种分类的实际应用1-js/01-getting-started/index.md 属于章节入口内容为“An introduction / About the JavaScript language and the environment to develop with it.”对 JavaScript 语言及其开发环境的介绍1-js/02-first-steps/01-hello-world/article.md 属于文章正文完整讲解script标签、现代标记写法与外部脚本等知识1-js/02-first-steps/01-hello-world/1-hello-alert/task.md 属于任务要求创建页面弹出“Im JavaScript!”提示其同目录下的 solution.md 即为配套题解。文章正文的写作格式示例仓库使用一种“增强版 markdown”格式书写教程内容README 特别指出可以在任何编辑器中直接编辑文本格式易于上手。以 1-js/02-first-steps/01-hello-world/article.md 为例可以看到文章正文由以下元素构成一级标题如# Hello, world!小节标题如## The script tag、## Modern markup、## External scripts、## Summary代码块用于展示 HTML 与 JavaScript 示例特殊提示框文中使用smart信息框与warn警告框标注附加说明例如关于浏览器缓存外部脚本的说明、以及“src设置后脚本内容将被忽略”的警告小结每篇正文以## Summary收尾列出该节的关键知识点。1-js/01-getting-started/1-intro/article.md 则展示了更多格式能力包括compare比较块用于列出 JavaScript 的三个独特优势、带标题的smart提示框如解释为何语言名叫 JavaScript以及行内链接等。任务与题解的配对规则README 明确要求task.md代表一个任务题解必须同时以solution.md文件提供。仓库中有大量这样的配对实例1-js/02-first-steps/01-hello-world/1-hello-alert/task.md 要求“创建一个页面显示消息 Im JavaScript!”对应的 solution.md 通过[html srcindex.html]引用同目录下的 index.html 作为题解其中包含一个直接调用alert(Im JavaScript!)的script块1-js/02-first-steps/01-hello-world/2-hello-alert-ext/task.md 要求把上一题的脚本内容抽取到同目录下的外部文件alert.js中对应题解为 alert.js内容仅为一行alert(Im JavaScript!)。这种“任务文件夹 task.mdsolution.md 可选示例文件”的组织方式让每道练习题都自带可验证的参考答案非常适合作为边学边练的教材结构。如何贡献新内容README 对贡献流程的说明非常简洁核心要点如下可编辑性教程文本采用增强版 markdown 格式可直接在任何编辑器中修改提交方式发现问题、补充缺失主题、向读者解释概念均可通过提交 Pull RequestPR实现本地预览若想预览修改后的站点效果官方提供了本地运行教程的服务端程序见 README 中指向 javascript-tutorial/server 的链接可在本地搭建环境渲染预览新增材料README 强调“添加新内容非常简单”——只需遵循上述N-url文件夹命名与三种文件类型约定新建一个文件夹并在其中放入对应类型的index.md、article.md或task.md任务需配solution.md即可贡献者名单教程站点的关于页about会列出贡献者列表可通过 README 中的链接查看。总结本仓库以“每个材料一个文件夹、N-url命名、文件类型决定材料类型”为组织核心index.md是章节入口article.md是文章正文task.md是任务并必须配套solution.md所有材料都以# Main header一级标题开头正文使用增强版 markdown支持代码块、smart/warn提示框、compare比较块等元素新内容的添加遵循同一套约定修改文本即可配合本地服务端可预览站点效果最终通过 PR 合入仓库、同步到 javascript.info 在线站点。对希望参与《现代 JavaScript 教程》编写或翻译的开发者而言理解这份结构约定是入门仓库协作的第一步。赞分享文档/教程前端【免费下载链接】en.javascript.infoModern JavaScript Tutorial项目地址https://gitcode.com/gh_mirrors/en/en.javascript.info点击查看免费下载相关推荐OpenDrop文档贡献者指南写作风格与格式要求OpenDrop文档贡献者指南写作风格与格式要求 你是否在为OpenDrop贡献文档时遇到格式混乱、风格不统一的问题本文将系统介绍文档写作规范帮助你快速产网络通信从函数式风格到 class 语法重写 Modern JavaScript Tutorial 的 Clock 时钟类从函数式风格到 class 语法重写 Modern JavaScript Tutorial 的 Clock 时钟类 本篇指南以 Modern JavaScri文档/教程前端CTF Wiki 贡献文档要求解析从内容格式、结构合理性到仓库存储的完整规范CTF Wiki 贡献文档要求解析从内容格式、结构合理性到仓库存储的完整规范 CTF Wiki 是一个面向 CTF 学习者的开源安全知识库其知识文档由社区贡文档网络安全教程上一篇OpenAPI 3.0自动化测试完全指南基于awesome-openapi3工具链的实现方案下一篇video2x 新手上手10 分钟跑通第一次视频超分辨率创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考