TypeScript Handbook 教程
【免费下载链接】TypeScript-Handbook Deprecated, please use the TypeScript-Website repo instead 项目地址: https://gitcode.***/gh_mirrors/ty/TypeScript-Handbook
1. 项目目录结构及介绍
TypeScript Handbook 的源代码组织如下：
-
content: 主要的 Markdown 文件，包含了所有手册章节的内容。-
basics: 基础类型相关的章节 -
everyday-types: 每日编程中常见的类型 -
functions: 函数相关的内容 -
object-types: 对象类型的讨论 -
narrowing: 类型窄化 -
more-on-functions: 更多关于函数的信息 -
generics: 泛型 -
index: 索引文件，用于构建导航 - ... (其他子目录按主题划分)
-
-
public: 包含静态资源，如 CSS 样式表和图片。 -
scripts: 用于处理 Markdown 文件和构建站点的脚本。 -
site.json: 网站配置文件，定义了页面元数据和导航结构。 -
.gitignore,.editorconfig,tsconfig.json: 版本控制配置、编辑器配置和 TypeScript 项目配置文件。
这个项目是基于 Markdown 文档构建的在线手册，使用脚本将 Markdown 转换为 HTML 页面并部署到 web 服务器。
2. 项目的启动文件介绍
由于 TypeScript Handbook 是一个静态网站项目，没有传统的“启动”文件，比如 main.js 或者 app.py。取而代之的是，它依赖于构建脚本来转换 Markdown 文件和创建 HTML 页面。主要的构建流程由以下步骤完成：
- 运行
npm install来安装必要的依赖包，包括typescript和其他构建工具。 - 运行
npm run build或npm start，这会执行scripts/build.sh脚本，该脚本调用 TypeScript 应用来处理 Markdown 文件生成 HTML。 - 在本地开发时，使用
npm run serve会启动一个 Web 服务器，以便在浏览器中查看和测试更改。
这些命令都是通过 package.json 中的 scripts 部分定义的。
3. 项目的配置文件介绍
.editorconfig
.editorconfig 文件定义了文本编辑器的一致性设置，例如缩进风格和大小，它帮助维护团队间的代码格式一致性。
tsconfig.json
tsconfig.json 是 TypeScript 项目的配置文件，虽然这个项目本身不是 TypeScript 代码，但是它用于编译用于构建过程的 TypeScript 脚本。配置文件中的选项包括 ***pilerOptions 和 include/exclude，它们指定了 TypeScript 编译器应该如何处理源文件。
site.json
site.json 文件定义了网站的结构，包括导航菜单和页面属性。它告诉构建脚本如何生成最终的 HTML 导航条。
scripts/build.sh
这是一个 Bash 脚本，负责运行构建过程，它调用了 TypeScript 编译器和其他辅助工具来转换 Markdown 文件并准备 HTML 输出。
通过以上介绍，你应该对 TypeScript Handbook 项目的结构和工作原理有了基本理解，接下来可以通过阅读 Markdown 文件和运行构建脚本来更深入地探索这个项目。
【免费下载链接】TypeScript-Handbook Deprecated, please use the TypeScript-Website repo instead 项目地址: https://gitcode.***/gh_mirrors/ty/TypeScript-Handbook
