Jekyll 是一个简单的、基于 Ruby 的静态站点生成器,它可以将纯文本文件转换为静态网站和博客。以下是一些基本的步骤和概念,可以帮助你开始使用 Jekyll:
安装 Jekyll
- 安装 Ruby:Jekyll 是用 Ruby 编写的,因此你需要在你的计算机上安装 Ruby。
- 安装 Bundler:Bundler 是 Ruby 的包管理工具,可以帮助你管理项目的依赖关系。
- 安装 Jekyll:通过在终端或命令提示符中运行
gem install jekyll
来安装 Jekyll。
创建一个新的 Jekyll 站点
- 新建站点:使用
jekyll new my-site
命令创建一个新的 Jekyll 站点。 - 进入站点目录:通过
cd my-site
进入你的新站点目录。 - 启动本地服务器:使用
jekyll serve
命令启动本地服务器,你可以通过浏览器访问http://localhost:4000
来查看你的站点。
站点结构
一个基本的 Jekyll 站点包含以下文件和目录:
- _config.yml:配置文件,定义了站点的全局配置。
- _posts/:存放博客文章的目录,文件通常以日期开头,例如
2024-01-01-example-post.md
。 - _layouts/:存放模板文件的目录,这些模板定义了页面的布局。
- _includes/:存放可以被多个页面或布局重用的片段的目录。
- assets/:存放 CSS、JavaScript 和图片等静态文件的目录。
- index.md 或 index.html:站点的首页。
编写内容
- 撰写文章:在
_posts/
目录下创建 Markdown 文件,文件名遵循日期-标题的格式,例如2024-01-01-welcome-to-jekyll.md
。 - YAML 头信息:每篇文章的顶部都有一个 YAML 头信息块,用于定义文章的元数据,例如标题、作者和布局。
自定义主题
- 选择主题:你可以从 Jekyll 社区找到现成的主题,或者自己创建一个。
- 修改主题:通过编辑
_layouts/
和_includes/
目录下的文件来自定义你的站点的外观。
部署
- 本地测试:在部署之前,使用
jekyll serve
命令在本地测试你的站点。 - 部署到 GitHub Pages:如果你的站点是一个 GitHub 仓库,你可以很容易地将其部署到 GitHub Pages。
进阶使用
- 数据文件:使用 YAML、JSON 或 CSV 文件在站点中存储和重用数据。
- 插件:扩展 Jekyll 的功能,例如自动生成站点地图或集成评论系统。
这些是 Jekyll 的基本介绍和使用指南。如果你需要更详细的教程,可以查看 Jekyll 的官方文档,或者在网上找到许多优秀的教程和资源。