Jekyll 选项(options)和子命令(subcommand)小手册

news2024/12/25 1:18:35

建议直接通过侧边栏进行跳转查询。

本文将列出并介绍一些常用的 Jekyll 的命令选项(options)和子命令(subcommand),这样方便快速查看。如果你想找的这里没有列出,可以查看官方文档 《Configuration Options(部署选项)》

Jekyll的命令使用格式

Jekyll 的命令使用格式如下:

jekyll <子命令> [选项]

需要注意的是:Jekyll 的默认值可以通过根目录下的_config.yml配置文件来调整,这对开发很有帮助哦。

选项(Options)

指定源目录(-s, --source)

该选项用于指定生成哪个目录(文件夹)下的内容的网站,默认为当前目录./。格式如下:

jekyll -s [目录]
jekyll --source [目录]

如果想修改默认值,那么就在根目录下的_config.yml配置文件中,输入以下内容:

source: DIR

举个例子,我们想生成/usr/abc目录下的内容的网站,那么就可以输入以下命令:

jekyll --source /usr/abc

如果想每次都生成这个目录下的内容的网站,则可以通过_config.yml修改默认值:

source: /usr/abc

修改目标目录(-d, --destination)

这个命令主要用于修改生成的目录的位置和名字,默认为./_site(生成一个名为_site的目录,然后将生成的文件放在该文件下)。格式如下:

jekyll -d [目录]
jekyll --destination [目录]

_config.yml中的语句为:

destination: 目录

举个例子,我们想生成的目录名为docs(符合 GitHub 的要求),那么就可以输入以下命令:

jekyll --destination ./docs

也可以通过_config.yml修改默认值:

destination: ./docs

打开安全模式( --safe)

打开安全模式,禁用硬盘上非白名单的插件,并且忽略软链接(symbolic links)。默认参数值为false,也就是关闭安全模式,但是使用完下述选项将会激活,变成true,下一次还是默认false。格式如下:

jekyll --safe 

需要注意的是,这里是没有参数的。
如果想每次生成都打开安全模式,那么可以通过_config.yml设置如下语句:

safe: true

你还可以在_config.ymlwhitelist部分添加插件,以允许这些插件在安全模式下运行。

指定插件目录(-p, --plugins)

这个命令用于指定使用哪些目录下的插件(多个目录用逗号,隔开,没有空格),而不是默认目录下的。默认目录为./_plugins。格式如下

jekyll -p 插件目录1,插件目录2,...
jekyll --plugins 插件目录1,插件目录2,...

_config.yml中的语句为:

plugins_dir: 插件目录1,插件目录2,...

但是,假设我们将插件放在了./_plugins,而且没有开启安全模式,这时候想使用插件来生成,那么不用任何额外操作,Jekyll 将会自动调用插件。

指定布局(Layouts)目录( --layouts)

这个命令用于指定使用哪些目录下的 Layouts 布局文件,而不是使用默认目录下的。默认目录为./_layouts。格式如下

jekyll --layouts 目录  Layouts目录 (defaults to )

_config.yml中的语句为:

layouts_dir: 目录

生成Liquid渲染信息( --profile)

如果你想查看 Liquid 渲染的一些具体信息,那么就需要使用该选项。格式如下:

jekyll --profile

如果不使用该选项,那么生成过程如下:

$ jekyll b
Configuration file: /zhonguncle.github.io/_config.yml
            Source: /zhonguncle.github.io
       Destination: /zhonguncle.github.io/docss
 Incremental build: disabled. Enable with --incremental
      Generating... 
                    done in 0.042 seconds.
 Auto-regeneration: disabled. Use --watch to enable.

但是如果使用了--profile选项,那么会显示一些渲染过程的具体信息:

$ jekyll b --profile
Configuration file: /zhonguncle.github.io/_config.yml
            Source: /zhonguncle.github.io
       Destination: /zhonguncle.github.io/docs
 Incremental build: disabled. Enable with --incremental
      Generating... 

Build Process Summary: 

| PHASE      |   TIME |
+------------+--------+
| RESET      | 0.0001 |
| READ       | 0.0285 |
| GENERATE   | 0.0000 |
| RENDER     | 0.0150 |
| CLEANUP    | 0.0027 |
| WRITE      | 0.0141 |
| TOTAL TIME | 0.0604 |
 

Site Render Stats: 

| Filename                  | Count |  Bytes |  Time |
+---------------------------+-------+--------+-------+
| blogs.html                |     1 |  0.43K | 0.001 |
| _layouts/article.html     |     2 |  2.59K | 0.001 |
| _includes/navigation.html |     5 |  1.27K | 0.000 |
| _layouts/default.html     |     3 |  8.68K | 0.000 |
| index.html                |     1 |  0.88K | 0.000 |
| TOTAL (for 5 files)       |    12 | 13.85K | 0.003 |
 
                    done in 0.079 seconds.
 Auto-regeneration: disabled. Use --watch to enable.

查看帮助信息(-h, --help)

该命令可以让你在终端中,快速查看一些命令、选项,及其介绍。格式如下:

jekyll -h
jekyll --help

显示的内容如下:

$ jekyll -h
jekyll 4.3.1 -- Jekyll is a blog-aware, static site generator in Ruby

Usage:

  jekyll <subcommand> [options]

Options:
        -s, --source [DIR]  Source directory (defaults to ./)
        -d, --destination [DIR]  Destination directory (defaults to ./_site)
            --safe         Safe mode (defaults to false)
        -p, --plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]  Plugins directory (defaults to ./_plugins)
            --layouts DIR  Layouts directory (defaults to ./_layouts)
            --profile      Generate a Liquid rendering profile
        -h, --help         Show this message
        -v, --version      Print the name and version
        -t, --trace        Show the full backtrace when an error occurs

Subcommands:
  compose               
  docs                  
  import                
  build, b              Build your site
  clean                 Clean the site (removes site output and metadata file) without building.
  doctor, hyde          Search site and print specific deprecation warnings
  help                  Show the help message, optionally for a given subcommand.
  new                   Creates a new Jekyll site scaffold in PATH
  new-theme             Creates a new Jekyll theme scaffold
  serve, server, s      Serve your site locally

查看当前使用的Jekyll版本(-v, --version)

使用该命令将会显示当前 Jekyll 版本。格式如下:

jekyll -v
jekyll --version

实际效果如下:

$ jekyll -v
jekyll 4.3.1

显示完整的backtrace(-t, --trace)

使用该选项,会在出现错误的时候,显示完整的回溯(backtrace),方便我们查找出错的地方。格式如下

jekyll -t
jekyll --trace

不过一些简单的错误信息,不使用该命令也可以看到。

子命令(Subcommand)

子命令可以理解成没有-的选项,放在jekyll后面。

生成构建网站(build, b)

Jekyll 本质是一个生成器,将特定结构、语句构成的源文件生成为网站文件。当我们开发完毕之后,便可以使用该子命令生成网站:

jekyll build
jekyll b

生成的网站默认在目录.\_site下,如果你想更改还请查看“修改目标目录”部分。

清除生成的网站和元数据(clean)

在生成一个网站之后,可以使用以下子命令来清除生成的网站和元数据:

jekyll clean

虽然你也可以手动删除生成的文件夹,但是比较麻烦。而且有些站点开发流程比较复杂,容易搞混删错了。所以这样清理比较方便干净安全。

本地实时运行你的网站(serve, server, s)

在本地开发的过程中,需要不断检查更改后的效果,但是如果每次都使用jekyll build未必有点太麻烦了。此时可以使用下面这个命令来实时运行本地站点,可以通过http://localhost:4000查看运行效果:

jekyll serve
jekyll server
jekyll s

这个子命令在运行的时候,如果修改了源文件,会自动进行生成。这时候只要刷新网站即可。
如果想终止,那么使用“Ctrl 键 + C 键”即可终止。

查看帮助信息(help)

如果想查看帮助信息可以使用下面这个子命令:

jekyll help

这个子命令和--help-h选项是一个效果。

创建一个新的Jekyll脚手架(new)

该子命令将会在指定路径下创建一个新的 Jekyll 站点。

jekyll new 路径

这个站点是 Jekyll 的官方演示,也可以理解成一个脚手架(生成了基础内容,自己进行一些修改即可)。内容如下:
请添加图片描述

请添加图片描述

如果你想生成一个空的项目,那么就在后面加上--blank,如下:

jekyll new 路径 --blank

检查你的项目是否有一些问题(doctor, hyde)

下面这两个子命令将会搜索你的项目,并且指出你的项目有哪些问题:

jekyll doctor
jekyll hyde

举个例子,之前生成的那个脚手架项目下,使用该命令,显示内容如下:

$ jekyll doctor
Configuration file: /zhonguncle.github.io/test/_config.yml
       Jekyll Feed: Generating feed for posts
           Warning: You didn't set an URL in the config file, you may encounter problems with some plugins.
           Warning: Your site URL does not seem to be absolute, check the value of `url` in your config file.

这里指出两个问题:

  1. 我们没有在配置文件中设置 URL,这可能导致一些关于插件的问题;
  2. 站点的 URL 并不是绝对 URL,我们需要对其进行检查。

本文后续可能会进行补充或修改,希望能帮到有需要的人~

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/11918.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

JPA Buddy指南

1. 概述 JPA Buddy是一个广泛使用的IntelliJ IDEA插件&#xff0c;面向使用JPA数据模型和相关技术&#xff08;如Spring DataJPA&#xff0c;DB版本控制工具&#xff08;Flyway&#xff0c;Liquibase&#xff09;&#xff0c;MapStruct等&#xff09;的新手和有经验的开发人员。…

猿创征文|C++软件开发值得推荐的十大高效软件分析工具

目录 1、概述 2、高效软件工具介绍 2.1、窗口查看工具SPY 2.2、Dependency Walker 2.3、剪切板查看工具Clipbrd 2.4、GDI对象查看工具GDIView 2.5、Process Explorer 2.6、Prcoess Monitor 2.7、API Monitor 2.8、调试器Windbg 2.9、反汇编工具IDA 2.10、抓包工具…

【毕业设计】深度学习试卷批改系统 - opencv python 机器视觉

文章目录0 简介1 项目背景2 项目目的3 系统设计3.1 目标对象3.2 系统架构3.3 软件设计方案4 图像预处理4.1 灰度二值化4.2 形态学处理4.3 算式提取4.4 倾斜校正4.5 字符分割5 字符识别5.1 支持向量机原理5.2 基于SVM的字符识别5.3 SVM算法实现6 算法测试7 系统实现8 最后0 简介…

使用react开发谷歌插件

前言 自己搭架子确实不会&#xff0c;好在github上有已经搭好的架子&#xff0c;具体见&#xff1a;https://github.com/satendra02/react-chrome-extension 项目是基于react16和scss的还是挺不错的。 不过这个是基于v2版本的&#xff0c;现在已经是v3版本了&#xff0c;我们…

【面试题】近期学员被问最多的真实面试题记录(如何分配测试任务?)

问题均由朋友/粉丝提供的真实面试记录&#xff0c;帮大家解答&#xff0c;我义不容辞&#xff0c;但有些问题如果回答的不够仔细和正确&#xff0c;也希望大家能客观的指出改正&#xff0c;轻喷。 问题&#xff1a;发现了线上bug&#xff0c;作为测试&#xff0c;你是如何发挥…

net基于asp.net的二手商品的交易系统-二手网站-计算机毕业设计

项目介绍 基于ASP.NET的二手商品的交易系统是针对目前二手商品交易的实际需求,从实际工作出发,对过去的二手商品交易平台存在的问题进行分析,完善用户的使用体会。采用计算机系统来管理信息,取代人工管理模式,查询便利,信息准确率高,节省了开支,提高了工作的效率。 本系统结合计…

GitHub神坛变动,10W字Spring Cloud Alibaba笔记,30W星标登顶第一

Spring Cloud Alibaba是Spring Cloud下的一个子项目&#xff0c;使用 Spring Cloud Alibaba&#xff0c;只需添加一些注解和少量配置&#xff0c;即可将 Spring Cloud 应用连接到 Alibaba 的分布式解决方案中&#xff0c;并使用 Alibaba 中间件构建分布式应用系统。 ​为了帮助…

高手PM控制项目范围的流程和方法!

​项目的范围、成本与质量相互制约。 如果不能使用合理的手段和方法确定项目范围&#xff0c;不能在项目过程中有效的控制范围&#xff0c;不能让项目范围在各相关方之间达成一致&#xff0c;那么会对项目造成严重的伤害。 如无情消耗项目资源&#xff0c;影响范围内工作的有…

手机怎么把照片转JPG格式?这三种手机小技巧需要知道

怎么用手机把照片的格式转换成JPG格式呢&#xff1f;大家在日常中使用的照片&#xff0c;有的格式可能连自己都不清楚&#xff0c;只有在特定格式的情况下才会才会发现自己的图片格式需要转换才行&#xff0c;最常使用到的就是将照片转换成JPG格式了&#xff0c;那么我们怎么用…

最新解决谷歌翻译无法使用的教程

谷歌翻译无法使用是谷歌官方关闭了中国地区翻译服务。 废话不多说直接上教程&#xff0c;本质就是通过修改hosts文件让translate.googleapis.com域名的IP解析到国内的谷歌服务器IP&#xff0c;网上大部分的教程也是如此。 但是有个问题就是这个IP不稳定可能用了几天就不用了&am…

web前端期末大作业:青岛旅游网页主题网站设计——青岛民俗4页 HTML+CSS 民俗网页设计与制作 web网页设计实例作业 html实训大作业

&#x1f468;‍&#x1f393;静态网站的编写主要是用 HTML DⅣV CSSJS等来完成页面的排版设计&#x1f469;‍&#x1f393;&#xff0c;一般的网页作业需要融入以下知识点&#xff1a;div布局、浮动定位、高级css、表格、表单及验证、js轮播图、音频视频Fash的应用、uli、下拉…

有哪些编辑图片加文字的软件?这些软件值得收藏

大家平时在分享自己拍的照片的时候&#xff0c;会不会觉得照片有点单调&#xff0c;有些空旷呢&#xff1f;其实这时候&#xff0c;我们只需要对图片添加上一些文字描述&#xff0c;就可以大大提高图片的趣味性以及丰富图片的内容&#xff0c;并且我们也可以将这些加文字的图片…

LDO的前世今生

众所周知&#xff0c;开关电源的效率很高&#xff0c;但是输出电压有纹波&#xff0c;噪声很大&#xff0c;不能直接接入单片机控制电路中&#xff0c;而一般选择的方案都是在开关电源的输出端接一级LDO低压差线性稳压电源&#xff0c;可以保证输出到单片机中的电压很稳定&…

C语言知识之字符串

字符串 Problem Description 给你一个长度为l&#xff08;l<150&#xff09;的字符串&#xff0c;字符串包含很多个单词&#xff0c;每2个单词之间用一个或多个空格隔开&#xff0c; 单词内可能包含"?",例如单词"china"可能在字符串中表示为"c?h…

AIGC困局与Web3破圈之道

最近一年&#xff0c;随着 AIGC&#xff08;AI-Generated Content&#xff09; 技术的发展壮大&#xff0c;越来越多的人感受到了它的恐怖之处。AI 降低了创作门槛&#xff0c;使每个普通人都有机会展现自己的创造力&#xff0c;做出不输专业水平的作品。但是就在全民 AI 作图的…

JavaEE——Tomcat和servlet

Tomcat tomcat是一个http的服务器&#xff0c;用来简化我们的网站开发 大家在下载的时候&#xff0c;如果jdk是8&#xff0c;那么tomcat也应该大版本是8 安装解压缩后&#xff0c;可以看到其中的一系列目录 bin 是tomcat的启动脚本&#xff08;start.bat是windows用的&#x…

分布式IO系统应用连接华为云

分布式IO系统华为云设置 启用设置 &#xff1a;勾选启用 认证方式 &#xff1a;可选择设备秘钥方式和认证证书方式&#xff0c;认证证书方式需要上传证书 设备 ID &#xff1a;华为云创建设备时生成的设备 ID 服务 ID &#xff1a;产品需要创建服务才能上报数据 地域(Region …

Fiddler Classic 替换本地JS并远程调试

背景 众所周知&#xff0c;下载的m3u8文件无法直接播放&#xff0c;一般来讲m3u8文件采用AES128对称加密&#xff0c;并提供key、iv、ts列表。当然文件中的key与iv均为加密后的结果&#xff0c;需配合相应的解密文件与偏移量。本文基于某利威的player.js介绍如何利用Fiddler进…

Cesium案列学习(Multi-partCZML.html)

在学习这个案例之前&#xff0c;先花一点时间了解一下什么是CZML CZML Structure AnalyticalGraphicsInc/czml-writer Wiki (github.com) Cesium Language (CZML) 入门1 — CZML Structure&#xff08;CZML的结构&#xff09; - laixiangran - 博客园 CZML是JSON得一个子集…

面试官问我:一个 TCP 连接可以发多少个 HTTP 请求?我竟然回答不上来...

一道经典的面试题是从 URL 在浏览器被被输入到页面展现的过程中发生了什么&#xff0c;大多数回答都是说请求响应之后 DOM 怎么被构建&#xff0c;被绘制出来。但是你有没有想过&#xff0c;收到的 HTML 如果包含几十个图片标签&#xff0c;这些图片是以什么方式、什么顺序、建…