Jekyll Garden 开源项目使用指南

Jekyll Garden 开源项目使用指南

jekyll-garden.github.ioA Digital Garden Theme for Jekyll. Jekyll Garden lets you create a static HTML version of your markdown notes and publish via Github pages. Made for Obsidian users!项目地址:https://gitcode.com/gh_mirrors/je/jekyll-garden.github.io

本指南将引导您了解并使用 Jekyll Garden，这是一个专为Obsidian用户设计的Markdown友好型主题，使您可以将Obsidian笔记（或其子集）发布为Jekyll静态网站。下面是关于项目的核心组成部分的详细介绍。

1. 项目目录结构及介绍

Jekyll Garden的目录结构遵循典型的Jekyll布局，包含以下几个关键部分：

• _includes: 包含可重用的HTML片段，如页头、页脚等。
• _layouts: 定义页面的布局样式，比如默认的文章布局、主页布局等。
• _notes: 存放您的Markdown笔记，这些笔记将被转换成网页。
• _site: 运行时自动生成的静态网站文件夹，不直接编辑此文件夹内的内容。
• assets: 包括CSS、JavaScript和其他静态资源，用于美化和增强网站功能。
• config.yml: Jekyll的主要配置文件。
• index.html: 网站的入口文件。
• README.md: 项目说明文档，通常包括安装和快速入门指南。

2. 项目启动文件介绍

• index.html: 虽然不是直接用于启动项目，但它是访问网站时的第一个界面，定义了主页的内容和展示方式。
• Gemfile: 若使用 Bundler 来管理Ruby依赖，这个文件列出所需的gem，确保开发环境的一致性。
• _config.yml: 此文件是项目的核心配置所在，包括站点元数据、静态文件路径、作者信息、导航条设置等。更改此文件会影响整个站点的行为和外观。

3. 项目的配置文件介绍

_config.yml 文件是Jekyll项目的灵魂，下面是一些可能在该文件中找到的关键配置项示例：

title: "我的数字花园"
timezone: "Asia/Shanghai"
markdown: kramdown
gems:
  - jekyll-seo-tag
  - jekyll-sitemap
exclude:
  - "*.lock"
  - Gemfile
  - Gemfile.lock
  - node_modules/
  - vendor/bundle/
collections:
  notes: # 如果有配置笔记集合，这里会定义相关参数
    output: true

• title: 网站的标题。
• timezone: 指定的时间区域。
• markdown: 指定使用的Markdown解析器。
• gems: 需要激活的Jekyll插件。
• exclude: 构建过程中需要排除的文件或目录。
• collections: 定义项目中的特殊集合，例如这里的“notes”集合，允许按类别组织笔记。

为了启动项目，你需要先确保本地环境中安装了Ruby和Bundler，并且能够运行Jekyll。接着，在项目根目录下执行以下命令：

bundle install # 安装必要的宝石（依赖）
bundle exec jekyll serve # 启动本地服务器预览

通过上述步骤，您就可以开始探索和定制属于自己的数字花园了。记得根据您的需求调整_config.yml和笔记内容，以达到最佳展示效果。

jekyll-garden.github.ioA Digital Garden Theme for Jekyll. Jekyll Garden lets you create a static HTML version of your markdown notes and publish via Github pages. Made for Obsidian users!项目地址:https://gitcode.com/gh_mirrors/je/jekyll-garden.github.io