Typst O'Reilly Template 项目启动与配置教程

1. 项目的目录结构及介绍

在克隆或下载该项目后，您将看到以下目录结构：

typst-oreilly-template/
├── _includes/
│   ├── footer.html
│   ├── header.html
│   └── toc.html
├── _layouts/
│   ├── base.html
│   └── page.html
├── _posts/
│   └── 2023-01-01-welcome-to-oreilly.md
├── assets/
│   ├── css/
│   │   └── style.css
│   └── js/
│       └── script.js
├── book.json
├── Gemfile
├── Gemfile.lock
├── INDEX.md
└── README.md

以下是各目录和文件的简要说明：

• _includes/：包含可以被其他文件包含的HTML片段。
• _layouts/：包含Jekyll布局文件，用于定义页面的基本结构。
• _posts/：包含所有的文章文件，以Markdown格式编写。
• assets/：包含项目的静态资源，如CSS样式表和JavaScript脚本。
• book.json：包含书籍的元数据和配置信息。
• Gemfile 和 Gemfile.lock：用于Ruby的依赖管理，Jekyll构建网站时需要。
• INDEX.md：书籍的起始页面，通常作为目录或简介。
• README.md：项目的说明文件，包含了项目的基本信息和如何使用。

2. 项目的启动文件介绍

INDEX.md 是项目的起始页面，它通常用作书籍的目录或者简介。在这个文件中，您可以编辑内容，以提供一个关于书籍的概述或者章节列表。

例如，INDEX.md 文件可能看起来像这样：

# Typst O'Reilly Template

欢迎来到这本书的起始页面！

以下是本书的目录：

- [第一章：简介](chapter1.md)
- [第二章：安装指南](chapter2.md)
- [第三章：使用方法](chapter3.md)

3. 项目的配置文件介绍

book.json 文件是用于配置书籍的元数据和布局的文件。以下是一些常见的配置选项：

{
  "title": "Typst O'Reilly Template",
  "author": "Your Name",
  "description": "这是一本使用Typst O'Reilly Template编写的示例书籍。",
  "language": "zh",
  "gitbook": "3.2.3"
}

在这个配置文件中，您可以设置书籍的标题、作者、描述、语言以及GitBook的版本。

确保正确配置这些文件后，您可以使用以下命令来预览书籍：

gitbook serve

这将启动一个本地服务器，并且您可以通过浏览器访问 http://localhost:4000 来预览您的书籍。