Code Guide 项目教程

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

Code Guide 项目的目录结构如下：

code-guide/
├── _includes/
├── _layouts/
├── _sass/
├── editorconfig
├── gitignore
├── CNAME
├── LICENSE.md
├── README.md
├── _config.yml
├── cg.scss
├── code-guide-logo.png
├── code-guide-social.png
├── code-guide.svg
├── favicon.ico
└── index.md

目录结构介绍

• _includes/: 包含项目中使用的各种模板片段。
• _layouts/: 包含项目的布局模板。
• _sass/: 包含项目的 Sass 文件，用于生成 CSS。
• editorconfig: 编辑器配置文件，用于统一代码风格。
• gitignore: Git 忽略文件配置。
• CNAME: 用于 GitHub Pages 的自定义域名配置。
• LICENSE.md: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• _config.yml: Jekyll 项目的配置文件。
• cg.scss: 项目的 Sass 主文件。
• code-guide-logo.png: 项目的 Logo 图片。
• code-guide-social.png: 项目的社交分享图片。
• code-guide.svg: 项目的 SVG 图标。
• favicon.ico: 项目的 Favicon 图标。
• index.md: 项目的主页内容。

2. 项目的启动文件介绍

Code Guide 项目使用 Jekyll 作为静态站点生成器。启动文件主要是 index.md 和 _config.yml。

index.md

index.md 是项目的主页文件，包含了项目的介绍、使用说明以及目录结构等信息。启动项目时，Jekyll 会自动将 index.md 转换为 HTML 文件并作为主页展示。

_config.yml

_config.yml 是 Jekyll 的配置文件，包含了项目的各种配置选项，如站点标题、描述、URL、作者信息等。启动项目时，Jekyll 会读取该文件中的配置信息。

3. 项目的配置文件介绍

Code Guide 项目的主要配置文件是 _config.yml。以下是该文件的部分配置内容：

title: Code Guide
description: Standards for developing consistent, flexible, and sustainable HTML and CSS.
url: https://codeguide.co
author:
  name: mdo
  email: [e-mail]
markdown: kramdown
highlighter: rouge

配置文件介绍

• title: 项目的标题。
• description: 项目的描述。
• url: 项目的 URL。
• author: 作者信息，包括姓名和邮箱。
• markdown: 使用的 Markdown 解析器。
• highlighter: 代码高亮工具。

通过这些配置，Jekyll 能够正确生成项目的静态站点，并展示相关信息。