Jekyll 的机制、转换步骤和结构介绍
admin
2024-01-28 08:05:41
0

Jekyll 是一个转换器,用来生成网站,使用的是一种解释语言。

本文将从三个方面来介绍 Jekyll:机制、转换顺序(解释顺序)和项目的文件结构。在项目的文件结构中,将会讲述一下每个关键目录和文件的作用。

机制

Jekyll 通过在生成静态 HTML 输出时,渲染 Liquid、Markdown 和进行其他转换,从而将原始的一堆文本文件转换为静态网站。 所以Jekyll 的运行机制可以大致总结成:将使用 Jekyll 和 HTML、CSS 语句混合写成的源文件,转换成纯 HTML、CSS 语言文件,以此来生成静态网站。

因此,在工作流程上便是典型的“三步走”:

  1. 设计、开发页面和调整配置文件;
  2. 生成网站(使用jekyll buildjekyll server);
  3. 查看生成网站的效果。

转换顺序(解释顺序)

Jekyll 将按照以下顺序进行转换:

  1. 通过查看你的文件来确定并赋予站点变量的值。站点变量有sitepage等,官方文档为《Site VariablesPermalink》。
  2. 处理页面文件的前事项中包含的的 Liquid 语句;
  3. 将 Markdown 文件转换为 HTML 文件;
  4. 将每个页面的内容放入 Layout 布局的{{ content }}标签中;
  5. 最后,将转换生成的内容放入指定的目录下。以_开头的目录将不会出现在生成文件中。

项目结构

一个 Jekyll 项目的文件结构应该大致如下:

.
├── _config.yml
├── _data
│   └── members.yml
├── _drafts
│   ├── begin-with-the-crazy-ideas.md
│   └── on-simplicity-in-technology.md
├── _includes
│   ├── footer.html
│   └── header.html
├── _layouts
│   ├── default.html
│   └── post.html
├── _posts
│   ├── 2007-10-29-why-every-programmer-should-play-nethack.md
│   └── 2009-04-26-barcamp-boston-4-roundup.md
├── _sass
│   ├── _base.scss
│   └── _layout.scss
├── _site
├── .jekyll-cache
│   └── Jekyll
│       └── Cache
│           └── [...]
├── .jekyll-metadata
├── assets
│   ├── css
│   └── image
└── index.html或者index.md(需要在前事项中进行说明)

下面依次来介绍一下每个文件夹和文件的作用:

  • _config.yml:项目配置文件。
  • _data:存放网站数据。Jekyll 将会自动加载此目录下的所有数据文件(后缀为.yml.yaml.json.csv.tsv),并且可以通过站点变量site.data访问这些文件。
    • members.yml:如果_data目录下有该文件,那么可以通过站点变量site.data.members访问文件内容。
  • _drafts:该目录下存放未发布的博客的草稿。这些文件的名称不写日期,格式为:title.MARKUP
    • begin-with-the-crazy-ideas.mdon-simplicity-in-technology.md是存放在_drafts目录下的草稿。
  • _includes:该目录下存放的文件,由layout布局文件和帖子混合,以方便重用。比如导航栏等需要重复使用的源码。
    • footer.html:该文件便是用于重复使用的脚注源码。
    • header.html:该文件便是用于重复使用的眉头源码。
  • _layouts:该目录存储页面模板。
    • default.html是默认的页面模版,也就是网站中几乎每个页面都会重复的部分。
    • post.html是用在帖子页面的模板。
  • _posts:该目录存放的是帖子,搭配上post模板便可生成一个个帖子页面。该目录下的文件名应该按照YEAR-MONTH-DAY-title.MARKUP的格式,这样在记录标题的同时,还可以记录帖子的发布时间。
    • 2007-10-29-why-every-programmer-should-play-nethack.md便表示的是 2007 年 10 月 29 日发布的一篇名为《why every programmer should play nethack》帖子。
    • 2009-04-26-barcamp-boston-4-roundup.md便表示的是 2009 年 4 月 26 日发布的一篇名为《barcamp Boston 4 roundup》帖子。
  • _sass:该目录下用于存放 Sass 文件(Sass 是一个 CSS 扩展语言,后缀有三种,分别是.sass.scss.coffee),可以将其处理成单个的 CSS 文件。该目录也可以直接命名为css
    • _base.scss是用于生成基础 CSS 的 Sass 文件。
    • _layout.scss是用于生成布局 CSS 的 Sass。
  • _site:该目录下便是默认生成的站点。
  • .jekyll-cache:保留例如jekyll serve时生成的页面和标记(例如 Markdown)的副本,以便更快推送服务。可以使用--disable-disk-cache选项,或者在_config.yml中使用disable_disk_cache: BOOL来不生成副本。
  • .jekyll-metadata:该文件帮助 Jekyll 跟踪上次构建之后,哪些文件没有被修改,哪些文件需要在下一次构建中重新生成。
  • assets:该目录下存放网站需要的 CSS、JS 和图像文件。
    • css:该目录下存放网站使用的 CSS 文件(这个和前面的_sass不同,这个和一般的网站 CSS 文件是一个东西)
    • image:该目录下存放网站使用的图像文件。
  • index.html或者index.md:这便是要生成的站点的首页面。

官方文档为:《Directory Structure》

希望能帮到有需要的人~

相关内容

热门资讯

linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
C++ 机房预约系统(六):学... 8、 学生模块 8.1 学生子菜单、登录和注销 实现步骤: 在Student.cpp的...
A.机器学习入门算法(三):基... 机器学习算法(三):K近邻(k-nearest neigh...
数字温湿度传感器DHT11模块... 模块实例https://blog.csdn.net/qq_38393591/article/deta...
有限元三角形单元的等效节点力 文章目录前言一、重新复习一下有限元三角形单元的理论1、三角形单元的形函数(Nÿ...
Redis 所有支持的数据结构... Redis 是一种开源的基于键值对存储的 NoSQL 数据库,支持多种数据结构。以下是...
win下pytorch安装—c... 安装目录一、cuda安装1.1、cuda版本选择1.2、下载安装二、cudnn安装三、pytorch...
MySQL基础-多表查询 文章目录MySQL基础-多表查询一、案例及引入1、基础概念2、笛卡尔积的理解二、多表查询的分类1、等...
keil调试专题篇 调试的前提是需要连接调试器比如STLINK。 然后点击菜单或者快捷图标均可进入调试模式。 如果前面...
MATLAB | 全网最详细网... 一篇超超超长,超超超全面网络图绘制教程,本篇基本能讲清楚所有绘制要点&#...
IHome主页 - 让你的浏览... 随着互联网的发展,人们越来越离不开浏览器了。每天上班、学习、娱乐,浏览器...
TCP 协议 一、TCP 协议概念 TCP即传输控制协议(Transmission Control ...
营业执照的经营范围有哪些 营业执照的经营范围有哪些 经营范围是指企业可以从事的生产经营与服务项目,是进行公司注册...
C++ 可变体(variant... 一、可变体(variant) 基础用法 Union的问题: 无法知道当前使用的类型是什...
血压计语音芯片,电子医疗设备声... 语音电子血压计是带有语音提示功能的电子血压计,测量前至测量结果全程语音播报࿰...
MySQL OCP888题解0... 文章目录1、原题1.1、英文原题1.2、答案2、题目解析2.1、题干解析2.2、选项解析3、知识点3...
【2023-Pytorch-检... (肆十二想说的一些话)Yolo这个系列我们已经更新了大概一年的时间,现在基本的流程也走走通了,包含数...
实战项目:保险行业用户分类 这里写目录标题1、项目介绍1.1 行业背景1.2 数据介绍2、代码实现导入数据探索数据处理列标签名异...
记录--我在前端干工地(thr... 这里给大家分享我在网上总结出来的一些知识,希望对大家有所帮助 前段时间接触了Th...
43 openEuler搭建A... 文章目录43 openEuler搭建Apache服务器-配置文件说明和管理模块43.1 配置文件说明...