Jekyll Incorporated 开源项目使用指南

Jekyll Incorporated 开源项目使用指南

jekyll-incorporatedModern Jekyll based blog for companies项目地址:https://gitcode.com/gh_mirrors/je/jekyll-incorporated

一、项目目录结构及介绍

Jekyll Incorporated 是一个基于 Jekyll 的静态站点生成器扩展，旨在简化博客或企业网站的搭建过程。以下是其基本的目录结构以及关键组成部分的简要介绍：

.
├── _includes           # 包含所有页面可复用的部分，如页头、页脚等。
├── _layouts             # 自定义布局文件，用于定义页面的公共结构。
│   ├── default.html     # 默认的布局模板。
│   └── post.html       # 博客文章的特定布局。
├── _posts               # 存放 Markdown 格式的博客文章。
├── _sass                # SCSS 文件夹，用于存放项目的样式表，支持 Sass 功能。
│   └── _style.scss     # 主样式文件，编译成 style.css。
├── assets               # 静态资源，包括图片、JavaScript 和其他前端资源。
│   ├── css               # 编译后的 CSS 文件存放地。
│   └── js                # JavaScript 文件存放地。
├── config.yml          # Jekyll 的核心配置文件。
└── index.html           # 主页入口文件。

此结构遵循 Jekyll 的标准实践，使得维护和扩展变得简单。

二、项目的启动文件介绍

index.html

• 作用：项目的主页。通常包含了网站的主要内容展示或者导航引导部分。在这个文件中，你可以看到如何引用 _layout 下的布局来构建页面的内容结构。

_config.yml

• 重要性：这是项目的配置心脏。通过修改这个文件，你可以设置站点元数据（如标题、描述、作者信息），配置 URL 路径，启用或禁用某些特性，设定默认的布局和语言等。

_posts 目录下的 .md 文件

• 功能说明：这些 Markdown 文件是博客文章的实际内容所在。每篇文章都有一个固定的前缀格式（如 2023-04-01-title-of-your-post.md），这帮助 Jekyll 确定发布日期和排序。

三、项目的配置文件介绍

_config.yml 内容概览

title: Jekyll Incorporated示例
author: 项目作者名
email: your@email.com
description: > # this means to ignore newlines until the next tag
  简短介绍您的网站或博客。
baseurl: "" # the subpath of your site, e.g. /blog
url: "http://your域名.com" # the base hostname & protocol for your site, e.g. http://example.com

# Build settings
markdown: kramdown
theme: minimal-mistakes-jekyll-theme
paginate: 5

• 标题(title) 和 描述(description) 定义了站点的基本信息，对于SEO至关重要。
• baseurl 和 url 设定了你的网站在互联网上的位置，确保正确配置以避免部署时的问题。
• markdown 指定了使用的解析引擎，这里使用的是 Kramdown。
• theme 表明了所使用的Jekyll主题，虽然在提供的链接中未直接提到特定主题，但通常你需要选择或自定义一个。
• paginate 设置了每一页显示的文章数，有助于提高用户体验。

通过细致调整这些配置项，你可以个性化你的Jekyll站点，满足特定的需求。确保在更改配置之后运行 jekyll serve 来预览效果。

jekyll-incorporatedModern Jekyll based blog for companies项目地址:https://gitcode.com/gh_mirrors/je/jekyll-incorporated