优秀的编程知识分享平台

网站首页 > 技术文章 正文

使用jekyll写Github-Pages(github pages jekyll)

nanyue 2025-03-14 19:26:53 技术文章 4 ℃

目录:



安装jekyll-mac下放弃

因为 Jekyll 是基于 Ruby 的静态网页生成系统,因此我们首先得安装 Ruby 环境,在 Mac 下我们可以使用的 Homebrew 来进行安装。如果是其他操作系统,可以去参考 Ruby 官方安装文档进行安装。

brew install ruby
gem install jekyll bundler

尝试过以下都不行:

brew reinstall ruby
brew install rbenv
gem install --user-install bundler jekyll
sudo gem install jekyll
sudo gem update --system
gem install --user-install jekyll
WARNING:  You don't have /Users/virhuiaivirhuiai/.gem/ruby/2.6.0/bin in your PATH,
      gem executables will not run.

export PATH="/Users/virhuiaivirhuiai/.gem/ruby/2.6.0/bin:$PATH"

。。。
放弃

安装jekyll-Docker

jekyll只是用来辅助写作的,不想多研究,找到Docker下的相关镜像:

# 搜索下
docker search jekyll
docker pull jekyll/jekyll:4.0
docker pull jekyll/minimal:4.0
docker pull jekyll/builder:4.0

可以选用上面的一个,一般选第一个标准版本就好,它的GitHub上的说明:

  • jekyll/jekyll: Default image.
  • jekyll/minimal: Very minimal image.
  • jekyll/builder: Includes tools.

The standard images (jekyll/jekyll) include a default set of “dev” packages, along with Node.js, and other stuff that makes Jekyll easy. It also includes a bunch of default gems that the community wishes us to maintain on the image.

The minimal image skips all the extra gems, all the extra dev dependencies and leaves a very small image to download. This is intended for people who do not need anything extra but Jekyll.

The builder image comes with extra stuff that is not included in the standard image, like lftp, openssh and other extra packages meant to be used by people who are deploying their Jekyll builds to another server with a CI.

运行容器

镜像的使用说明中写:

docker run --rm \
  --volume="$PWD:/srv/jekyll" \
  -it jekyll/jekyll:4.0 \
  jekyll build

由于我们还没有创建过,所以修改下改用:

# 进入本地的目录
cd /Users/virhuiaivirhuiai/Documents/virhuiai-github/
# 运行容器
docker run --name my-jekyll \
  -p 4000:4000 \
  --volume="$PWD:/srv/jekyll" \
  -it jekyll/jekyll:4.0 \
  /bin/sh

-p命令是为了方便后面直接在容器中运行,指定了端口。

生成

jekyll new pages

这会在当前目录下创建一个 pages 目录,里面包含一个示例的网站

因为没装tree,切到宿主机到相应的目录下查看下结构:

构建

切换到 pages 目录下,构建刚刚生成的网站:

jekyll build

默认会将网站生成到 ./_site 目录下,生成目录可以通过配置文件 ./_config.yml或命令行参数 --destination 设置:

virhuiaivirhuiai@virhuiaideMacBook-Pro pages % ls
404.html  Gemfile.lock  _config.yml _site   index.markdown
Gemfile   README.md _posts    about.markdown

本地预览

将网站运行起来,在本地进行预览:

jekyll server

然后可以在浏览器中 http://127.0.0.1:4000 来访问,显示如下界面

点击标题,进入详情页:

git添加_site到忽略.

提交前看了下,
/.jekyll-cache/Jekyll/Cache/
应该也可以加入忽略。

/_site/
/.idea/
/.jekyll-cache/Jekyll/Cache/

Tags:

最近发表
标签列表