Jekyll的目录结构

一个基本的Jekyll网站通常看起来是这样的:

.
├── _config.yml
├── _data
│   └── members.yml
├── _drafts
│   ├── begin-with-the-crazy-ideas.md
│   └── on-simplicity-in-technology.md
├── _includes
│   ├── footer.html
│   └── header.html
├── _layouts
│   ├── default.html
│   └── post.html
├── _posts
│   ├── 2007-10-29-why-every-programmer-should-play-nethack.md
│   └── 2009-04-26-barcamp-boston-4-roundup.md
├── _sass
│   ├── _base.scss
│   └── _layout.scss
├── _site
├── .jekyll-cache
│   └── Jekyll
│       └── Cache
│           └── [...]
├── .jekyll-metadata
└── index.html # can also be an 'index.md' with valid front matter

使用基于gem的主题的Jekyll网站的目录结构

3.2版本以来,一个由 jekyll new 启动的新Jekyll项目使用基于gem的主题来定义网站的外观。这导致了一个更轻的默认目录结构:_layouts_includes_sass默认存储在 theme-gem 中。

minima是当前的默认主题,bundle info minima 将显示minima主题的文件存储在您的计算机上的位置。

这些功能的概述:

File / Directory Description
_config.yml 存储configuration数据。其中许多选项可以从命令行可执行文件中指定,但在此处指定它们更容易,因此您不必记住它们。
_drafts 草稿是未发布的文章。这些文件的格式没有日期:title.MARKUP 。学习如何使用草稿。
_includes 这部分内容可以通过布局和文章进行混合和匹配,以便于重用。Liquid tag {% raw %}{% include file.ext %}{% endraw %} 可用于在 _includes/file.ext中包含这部分内容 。
_layouts 这些是包装文章的模板。布局是在front matter中基于文章逐篇选择的,这将在下一节中进行描述。Liquid tag {% raw %}{{ content }}{% endraw %} 用于将内容注入网页。
_posts 可以说是你的动态内容。这些文件的命名约定很重要,必须遵循以下格式:YEAR-MONTH-DAY-title.MARKUP。可以为每个文章自定义permalinks,但日期和markup语言仅由文件名决定。
_data 格式良好的站点数据应该放在这里。Jekyll引擎将自动加载此目录中的所有数据文件(使用.yml,.yaml, .json, .csv.tsv其中之一的格式和扩展名),并且可以通过site.data访问这些文件。如果目录下有一个members.yml文件,则可以通过site.data.members访问该文件的内容。
_sass 这些是sass部分,可以导入到您的main.scss中,然后将其处理到一个样式表main.css中,该样式表定义了您的网站要使用的样式。了解how to work with assets。
_site 一旦Jekyll完成转换,生成的网站就会放在这里(默认情况下)。最好将其添加到你的.gitignore文件中。
.jekyll-cache 保留生成的页面和markup(例如:markdown)的副本,以便更快地运行站点。使用时创建,例如:jekyll serve。可以使用an option and/or flag禁用。此目录将不会包含在生成的站点中。将其添加到.gitignore文件中可能是个好主意。
.jekyll-metadata 这有助于Jekyll跟踪自上次构建网站以来哪些文件没有被修改,以及哪些文件需要在下次构建时重新生成。仅在使用incremental regeneration时创建(例如:使用jekyll serve -I)。此文件将不会包含在生成的站点中。将其添加到.gitignore文件中可能是个好主意。
index.html or index.md and other HTML, Markdown files 如果该文件有一个front matter部分,它将由Jekyll转换。对于站点根目录或上面未列出的目录中的任何.html, .markdown, .md, 或 .textile文件,也会发生同样的情况。
Other Files/Folders 除了上面列出的特殊情况外,其他所有目录和文件,如cssimages文件夹、favicon.ico文件等,都将被逐字复制到生成的站点。有很多网站已经在使用Jekyll了,如果你很好奇它们是如何布局的话。
==================== ===================================

以下列字符开头的每个文件或目录:., _ , #source目录中的 ~ 将不会包含在destination文件夹中。这些路径必须通过include指令中的配置文件明确指定,以确保它们被复制:

include:
 - _pages
 - .htaccess
上一页 目录 下一页

你可能感兴趣的:(jekyll,ruby,前端)