Minimalist Jekyll 主题使用教程

Minimalist Jekyll 主题使用教程

minimalist Minimalist is a Jekyll theme inspired by the Minimal theme 项目地址: https://gitcode.com/gh_mirrors/min/minimalist

1. 项目目录结构及介绍

Minimalist 是一个基于 Jekyll 的主题，其目录结构如下：

minimalist/
├── _includes/
├── _layouts/
├── _sass/
├── assets/
├── script/
├── .editorconfig
├── .gitignore
├── Gemfile
├── LICENSE
├── README.md
├── _config.yml
├── another-page.md
├── deploy.sh
├── index.md
├── jekyll-theme-minimalist.gemspec
└── minimalist.png

目录结构介绍

• _includes/：包含用于页面布局的 HTML 片段。
• _layouts/：包含页面的布局模板。
• _sass/：包含主题的 Sass 文件。
• assets/：包含主题的静态资源文件，如 CSS、JavaScript 和图片。
• script/：包含用于启动和测试的脚本文件。
• .editorconfig：用于统一代码风格的配置文件。
• .gitignore：Git 忽略文件列表。
• Gemfile：定义项目所需的 Ruby gem 依赖。
• LICENSE：项目的开源许可证文件。
• README.md：项目的说明文档。
• _config.yml：Jekyll 的配置文件。
• another-page.md：示例页面文件。
• deploy.sh：用于部署的脚本文件。
• index.md：主页文件。
• jekyll-theme-minimalist.gemspec：主题的 gemspec 文件。
• minimalist.png：主题的 Logo 图片。

2. 项目启动文件介绍

deploy.sh

deploy.sh 是一个用于启动项目的脚本文件。使用 Docker 时，可以通过以下命令启动项目：

./deploy.sh

其他启动方法

如果不使用 Docker，可以通过以下步骤启动项目：

1. 安装 Jekyll 和 Bundler：

   gem install jekyll bundler
   

2. 安装项目依赖：

   bundle install
   

3. 启动本地服务器：

   bundle exec jekyll serve
   

3. 项目配置文件介绍

_config.yml

_config.yml 是 Jekyll 的主要配置文件，Minimalist 主题的配置项如下：

title: "Minimalist 主题"
description: "一个简洁的 Jekyll 主题"

# 可选配置项
google_analytics: "UA-XXXXX-Y"
color-scheme: auto
logo: /assets/img/logo.png
favicon: true

# 侧边栏配置
sidebar:
  - name: "Google Scholar"
    icon: "<svg>...</svg>"
    link: "https://scholar.google.com/citations?user=zR6afi8AAAAJ"
  - name: "GitHub"
    icon: "<i class='fa-brands fa-github'></i>"
    link: "https://github.com/BDHU"

配置项说明

• title：网站的标题。
• description：网站的简短描述。
• google_analytics：Google Analytics 的跟踪 ID。
• color-scheme：主题颜色方案，可选值为 auto、light 或 dark。
• logo：网站的 Logo 图片路径。
• favicon：是否启用 favicon。
• sidebar：侧边栏的配置，包含名称、图标和链接。

通过以上配置，可以自定义 Minimalist 主题的外观和功能。

minimalist Minimalist is a Jekyll theme inspired by the Minimal theme 项目地址: https://gitcode.com/gh_mirrors/min/minimalist