TypeScript 书籍项目教程

项目的目录结构及介绍

typescript-book/
├── README.md
├── book.json
├── content/
│   ├── 01-introduction.md
│   ├── 02-basics.md
│   ├── 03-advanced.md
│   └── ...
├── static/
│   ├── images/
│   └── styles/
└── theme/
    ├── fonts/
    ├── partials/
    └── styles/

• README.md: 项目介绍文件，包含项目的基本信息和使用说明。
• book.json: 项目的配置文件，用于定义书籍的结构和元数据。
• content/: 包含所有章节内容的目录，每个章节为一个单独的 Markdown 文件。
• static/: 静态资源目录，包含图片和样式文件。
• theme/: 主题目录，包含字体、部分模板和样式文件。

项目的启动文件介绍

项目的启动文件主要是 book.json 文件。这个文件定义了书籍的结构和元数据，包括章节的顺序、标题、作者等信息。以下是一个示例：

{
  "title": "TypeScript 书籍",
  "author": "gibbok",
  "plugins": ["highlight", "search"],
  "structure": {
    "readme": "README.md",
    "summary": "SUMMARY.md"
  }
}

• title: 书籍的标题。
• author: 作者信息。
• plugins: 使用的插件列表。
• structure: 定义书籍的结构，包括 readme 和 summary 文件的路径。

项目的配置文件介绍

项目的配置文件主要是 book.json 文件。这个文件不仅定义了书籍的结构和元数据，还包含了插件的配置和其他自定义设置。以下是一些常见的配置项：

{
  "title": "TypeScript 书籍",
  "author": "gibbok",
  "plugins": ["highlight", "search"],
  "pluginsConfig": {
    "highlight": {
      "theme": "github"
    },
    "search": {
      "maxIndexSize": 100000
    }
  },
  "structure": {
    "readme": "README.md",
    "summary": "SUMMARY.md"
  }
}

• pluginsConfig: 插件的配置项，例如代码高亮的主题和搜索插件的最大索引大小。
• structure: 定义书籍的结构，包括 readme 和 summary 文件的路径。

通过这些配置，可以自定义书籍的显示效果和功能，使其更符合项目需求。