Jekyll Postfiles 插件安装与使用指南

Jekyll Postfiles 插件安装与使用指南

jekyll-postfilesA Jekyll plugin that copies static files from the _posts to the _site folder项目地址:https://gitcode.com/gh_mirrors/je/jekyll-postfiles

---

1. 项目目录结构及介绍

Jekyll Postfiles 是一个专为 Jekyll 设计的插件，它解决了将静态文件（如图片、附件等）关联到特定博客文章的问题。下面是典型的项目结构布局，以及该插件涉及的关键目录说明：

标准 Jekyll 结构扩展

• _posts: 存放博客文章的主目录。
• _postfiles: 这个插件新增的特性，用于存放按文章命名的子目录，每个子目录对应一篇文章，并在其中放置该文章相关的文件。

举例来说，如果你有一篇文章叫 2023-04-01-my-blog-post.md，对应的文件结构可能如下：

_posts/
    2023-04-01-my-blog-post.md
_postfiles/
    2023-04-01-my-blog-post/
        image.jpg
        document.pdf

---

2. 项目的启动文件介绍

本项目的核心在于其作为 Jekyll 插件的角色，因此“启动”更多指的是在你的 Jekyll 站点中启用和集成插件的过程，而不是传统意义上的一个单一启动文件。

集成步骤简述:

1. 安装插件: 在你的 Jekyll 项目的根目录下，编辑 Gemfile，加入以下行来指定插件依赖：

   gem 'jekyll-postfiles', '~> 3.1'
   

2. 运行 bundle 安装: 在终端执行 bundle install 来安装新添加的宝石。

3. 配置 Jekyll: 在 _config.yml 中不需要特殊配置即可使用该插件，因为一旦正确安装，Jekyll 就会在构建过程中自动识别并应用这个插件。

---

3. 项目的配置文件介绍

对于 Jekyll Postfiles 插件本身，大多数情况下并不直接需要修改任何配置文件。它的运作依赖于默认行为，即查找 _postfiles 目录下的相关文件并将其复制到生成站点 (_site) 的相应位置，以便与文章一同发布。

然而，在你的 Jekyll 主配置文件 _config.yml 中，你可以通过调整 Jekyll 的全局设置间接影响插件的行为。例如，如果你改变了 Jekyll 的源目录或目标目录，插件也会随之适应这些变化。但请注意，Jekyll Postfiles 没有提供额外的自定义配置项，保持了其使用的简洁性。

使用时，只需确保文章中想要引用的文件正确放在对应的文章子目录下，并利用 Liquid 标签 {% postfile filename %} 来在文章内部引用这些文件。

以上便是 Jekyll Postfiles 插件的基本介绍和配置方法，遵循这些步骤，你可以轻松管理并关联文章与它们的附属文件。

jekyll-postfilesA Jekyll plugin that copies static files from the _posts to the _site folder项目地址:https://gitcode.com/gh_mirrors/je/jekyll-postfiles