Free-APIs.github.io 项目使用教程

Free-APIs.github.io 项目使用教程

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

Free-APIs.github.io/
├── _config.yml
├── _data/
│   └── apis.yml
├── _includes/
│   ├── footer.html
│   ├── head.html
│   └── header.html
├── _layouts/
│   ├── default.html
│   └── home.html
├── _posts/
│   └── 2023-01-01-example-post.md
├── assets/
│   ├── css/
│   │   └── main.scss
│   └── js/
│       └── main.js
├── index.html
└── README.md

• _config.yml: 项目的配置文件，用于设置网站的基本信息和配置。
• _data/: 存放项目的数据文件，例如 apis.yml 文件包含了API的详细信息。
• _includes/: 存放项目的HTML片段，例如页眉 (header.html)、页脚 (footer.html) 和头部 (head.html)。
• _layouts/: 存放项目的布局模板，例如默认布局 (default.html) 和首页布局 (home.html)。
• _posts/: 存放项目的博客文章，例如 2023-01-01-example-post.md。
• assets/: 存放项目的静态资源，例如CSS (css/main.scss) 和JavaScript (js/main.js) 文件。
• index.html: 项目的首页文件。
• README.md: 项目的说明文件，包含项目的简介和使用说明。

2. 项目的启动文件介绍

项目的启动文件是 index.html，这是网站的首页文件。当用户访问网站时，首先加载的就是这个文件。index.html 文件通常包含了网站的基本结构和内容，并且会引用 _includes/ 目录下的HTML片段和 assets/ 目录下的CSS和JavaScript文件。

3. 项目的配置文件介绍

项目的配置文件是 _config.yml，这是一个YAML格式的文件，用于配置网站的基本信息和行为。以下是 _config.yml 文件的一些常见配置项：

title: Free APIs
description: 一个免费的API集合
baseurl: ""
url: "https://free-apis.github.io"

• title: 网站的标题。
• description: 网站的描述。
• baseurl: 网站的基本URL路径。
• url: 网站的完整URL。

通过修改 _config.yml 文件，可以自定义网站的标题、描述、URL等信息，从而满足不同的需求。