目录结构如下:
.
├── _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-based主题的目录结构
Version 3.2 后,jekyll new创建的新项目使用 gem-based themes 来定义站点。这样,更轻量的目录结构:_layouts,_includesand_sass将被存储在theme-gem中,默认配置。
minima 作为默认主题,命令bundle info minima将展示主题文件存储路径。
| FILE / DIRECTORY | DESCRIPTION | |
|---|---|---|
_includes |
这部分可以供layouts和posts混合或匹配引用。 liquid tag {% include file.ext %} 可用于引用 _includes/file.ext 中的内容。 |
新版本位于themes目录下 |
_layouts |
Posts 的模板文件。可以根据post不同,在front matter配置不同layout。 liquid tag {{ content }} 用于向web page 注入内容。 |
新版本位于themes目录下 |
_sass |
这些是可以导入到main.scss中的sass部分,然后被转换为样式表main.css,main.css定义了站点要使用的样式。参见 how to work with assets。 |
新版本位于themes目录下 |
_config.yml |
配置文件。 | |
_drafts |
未发布的posts。文件格式:title.MARKUP。参考 work with drafts. |
|
_posts |
要发布的动态内容。文件的命名很重要,遵循格式:YEAR-MONTH-DAY-title.MARKUP。可以为每篇文章定制永久链接 permalinks ,但日期和标记语言仅由文件名决定。 |
|
_data |
存放格式化的数据。Jekyll引擎会自动加载目录中的所有的data文件(.yml, .yaml, .json, .csv or .tsv) ,可以通过site.data访问。对于文件members.yml ,还可以通过site.data.members访问文件内容。 |
|
_site |
Jekyll完成转换后生成的站点将被放置在此处(默认情况下)。推荐将其添加到.gitignore。 |
|
.jekyll-cache |
保留生成页面和标记(e.g.: markdown)的副本,以快速提供服务。当使用 e.g.: jekyll serve 的时候创建。可以通过 an option and/or flag关闭。该目录不包含在生成站点目录内。推荐将其添加到.gitignore。 |
|
.jekyll-metadata |
帮助Jekyll跟踪自上次构建站点以来哪些文件未被修改,以及哪些文件需要在下一次构建时重新生成。仅在使用 incremental regeneration (e.g.: with jekyll serve -I)时创建。 该目录不包含在生成站点目录内。推荐将其添加到.gitignore。 |
|
index.html or index.md and other HTML, Markdown files |
如果存在front matter 部分,会由Jekyll进行转换。同样适用于站点根目录、或如上未列出的目录的任意.html, .markdown, .md, or .textile 文件。 |
|
| Other Files/Folders | 除了上面列出的特殊情况外,其他目录和文件(如css和images目录,favicon.ico文件等等)都将被复制到生成站点。sites already using Jekyll |
源目录中以以下字符开头的文件或目录:., _ , # or ~ ,将不包括在目标文件夹中。必须通过include指令中的配置文件显式指定这些路径,以确保它们被复制到:
include:
- _pages
- .htaccess










网友评论