Jekyll Serve 项目教程

Jekyll Serve 项目教程

jekyll-serveJekyll in a Docker Container For Easy SSG Development项目地址:https://gitcode.com/gh_mirrors/je/jekyll-serve

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

jekyll-serve/
├── _config.yml
├── _data
│   └── members.yml
├── _drafts
│   ├── draft1.md
│   └── draft2.txt
├── _includes
│   ├── footer.html
│   └── header.html
├── _layouts
│   ├── default.html
│   └── post.html
├── _posts
│   ├── 2021-01-01-post1.md
│   └── 2021-01-02-post2.md
├── _sass
│   ├── _base.scss
│   └── _layout.scss
├── _site
├── .jekyll-cache
├── .gitignore
├── about.md
├── index.html
└── Gemfile

目录结构介绍

• _config.yml: 项目的配置文件。
• _data: 存储数据文件，如 members.yml。
• _drafts: 存放未发布的草稿文件。
• _includes: 存放可重用的模板片段，如 footer.html 和 header.html。
• _layouts: 存放页面布局模板，如 default.html 和 post.html。
• _posts: 存放已发布的文章，文件名格式为 YYYY-MM-DD-title.md。
• _sass: 存放 Sass 文件，用于样式表的编译。
• _site: 生成的静态网站目录，通常不包含在版本控制中。
• .jekyll-cache: Jekyll 的缓存目录，用于提高构建速度。
• .gitignore: Git 忽略文件列表。
• about.md: 关于页面的 Markdown 文件。
• index.html: 首页的 HTML 文件。
• Gemfile: 项目的依赖管理文件。

2. 项目的启动文件介绍

index.html

这是项目的入口文件，通常包含网站的首页内容。它使用 YAML 前置数据和 HTML 内容来定义页面的结构和内容。

---
layout: default
title: 首页
---
<h1>欢迎来到我的 Jekyll 网站</h1>
<p>这是一个示例首页。</p>

Gemfile

这是项目的依赖管理文件，定义了项目所需的 Ruby gems。

source 'https://rubygems.org'
gem 'jekyll'
gem 'webrick'

3. 项目的配置文件介绍

_config.yml

这是 Jekyll 项目的主要配置文件，包含网站的各种设置，如网站的 URL、标题、描述、作者信息等。

title: 我的 Jekyll 网站
email: example@example.com
description: >-
  这是一个使用 Jekyll 构建的静态网站示例。
baseurl: ""
url: "http://example.com"
twitter_username: jekyllrb
github_username:  jekyll

# 构建设置
markdown: kramdown
theme: minima
plugins:
  - jekyll-feed

配置文件介绍

• title: 网站的标题。
• email: 联系邮箱。
• description: 网站的描述。
• baseurl: 网站的基本 URL。
• url: 网站的完整 URL。
• twitter_username: Twitter 用户名。
• github_username: GitHub 用户名。
• markdown: 使用的 Markdown 处理器。
• theme: 使用的主题。
• plugins: 启用的插件列表。

以上是 Jekyll Serve 项目的目录结构、启动文件和配置文件的详细介绍。希望这些内容能帮助你更好地理解和使用该项目。

jekyll-serveJekyll in a Docker Container For Easy SSG Development项目地址:https://gitcode.com/gh_mirrors/je/jekyll-serve