SendGrid Docs 项目教程
1. 项目的目录结构及介绍
sendgrid-docs/
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── _config.yml
├── _data/
│ ├── categories.yml
│ ├── languages.yml
│ ├── products.yml
│ └── versions.yml
├── _includes/
│ ├── analytics.html
│ ├── footer.html
│ ├── head.html
│ ├── header.html
│ └── sidebar.html
├── _layouts/
│ ├── default.html
│ ├── page.html
│ └── post.html
├── _plugins/
│ ├── custom_filters.rb
│ └── custom_tags.rb
├── _posts/
│ └── 2023-01-01-example-post.md
├── assets/
│ ├── css/
│ ├── fonts/
│ ├── images/
│ └── js/
├── docs/
│ ├── api/
│ ├── email-api/
│ ├── smtp-api/
│ └── webhooks/
└── index.html
目录结构介绍
- CONTRIBUTING.md: 贡献指南文件,指导开发者如何为项目做出贡献。
- LICENSE.md: 项目许可证文件,说明项目的开源许可证类型。
- README.md: 项目介绍文件,通常包含项目的基本信息、安装和使用说明。
- _config.yml: Jekyll 配置文件,用于配置网站的基本设置。
- _data/: 包含项目的元数据文件,如分类、语言、产品和版本信息。
- _includes/: 包含网站的公共部分,如页眉、页脚、侧边栏等。
- _layouts/: 包含网站的布局模板,如默认布局、页面布局和文章布局。
- _plugins/: 包含自定义的 Jekyll 插件,用于扩展 Jekyll 的功能。
- _posts/: 包含博客文章的 Markdown 文件。
- assets/: 包含网站的静态资源,如 CSS、字体、图片和 JavaScript 文件。
- docs/: 包含项目的文档文件,按类别组织,如 API、Email API、SMTP API 和 Webhooks。
- index.html: 网站的首页文件。
2. 项目的启动文件介绍
项目的启动文件是 index.html
,它是网站的首页文件。该文件通常包含网站的基本结构和内容,是用户访问网站时首先看到的页面。
3. 项目的配置文件介绍
项目的配置文件是 _config.yml
,它是 Jekyll 的配置文件,用于配置网站的基本设置。以下是一些常见的配置项:
title: SendGrid Docs
description: Documentation for SendGrid services.
baseurl: ""
url: "https://sendgrid.com"
markdown: kramdown
highlighter: rouge
配置项介绍
- title: 网站的标题。
- description: 网站的描述。
- baseurl: 网站的基本 URL。
- url: 网站的完整 URL。
- markdown: 使用的 Markdown 解析器,这里是
kramdown
。 - highlighter: 使用的代码高亮工具,这里是
rouge
。
通过这些配置项,可以自定义网站的标题、描述、URL 等信息,以及选择使用的 Markdown 解析器和代码高亮工具。