Cryogen文档-配置

2014-03-11

Cryogen 提供了一些灵活的配置选项,配置文件在 templates/config.edn ,默认配置如下所示:

{:site-title         "My Awesome Blog"
 :author             "Bob Bobbert"
 :description        "This blog is awesome"
 :site-url           "http://blogawesome.com/"
 :post-root          "posts"
 :page-root          "pages"
 :post-root-uri      "posts-output"
 :page-root-uri      "pages-output"
 :tag-root-uri       "tags-output"
 :author-root-uri    "authors-output"
 :blog-prefix        "/blog"
 :rss-name           "feed.xml"
 :rss-filters        ["cryogen"]
 :recent-posts       3
 :post-date-format   "yyyy-MM-dd"
 :sass-src           nil
 :sass-dest          nil
 :theme              "blue"
 :resources          ["img"]
 :keep-files         [".git"]
 :disqus?            false
 :disqus-shortname   ""
 :ignored-files      [#"\.#.*" #".*\.swp$"]
 :posts-per-page     5
 :blocks-per-preview 2
 :previews?          false
 :clean-urls?        true}
 

配置选项

属性 描述
site-title 站点标题
author 站点作者
description 站点描述
site-url 站点根目录,当生成站点地图和 RSS 会被加上。
post-root 编译器通过它查找你的内容发布文件,必须配置。
page-root 编译器通过它查找你的页面发布文件,必须配置。
post-root-uri 编译后的 posts 文件放到这里,如果值为 nil 则被设置为 post-root 的值,如果值为("")则被设置为根目录(ie. resources/public/{blog-prefix}
page-root-uri 编译后的 pages 文件放到这里,如果值为 nil 则被设置为 page-root 的值,如果值为("")则被设置为根目录(ie. resources/public/{blog-prefix}
tag-root-uri tag pages 编译文件输出目录,如果不设置则会使用空字符串。
author-root-uri 如果你的站点有多个作者,设置这个值,编译器会为每个作者生成他所有的发表内容和页面,详细请看官方文档 这里
blog-prefix 追加到所有的 uri's,必须以斜杠开始。
rss-name 生成 rss 文件的名字, 默认为 rss.xml。
rss-filters 通过 tags 指定 RSS 文件内容的范围。
recent-posts 设置侧边栏 最近发表 的最多显示条数。
post-date-format 设置发布文件标题的日期格式,默认为 yyyy-MM-dd。
sass-src 这个目录用来放置 sass(scss) 文件,默认为 "css",确保将这个目录包含到 resources 中。
sass-dest 这个目录用来放置 sass(scss) 的编译文件,默认为 "css",确保将这个目录包含到 resources 中。
theme 这个设置用来指定 themes 目录下的站点主题,除了默认提供的,你可以添加自定的主题,必须设置。
resources 编译器复制 templates 的内容到 public
keep-files 当擦除 public 文件夹时,要保留的 目录/文件列表, 例如. 如果你计划将public文件夹发布到 Github Pages 上,那么你就要保留 .git 文件夹。
disqus? 如果你想用 Disqus,设置为 true,不设置默认为 false
disqus-shortname 你的 Disqus 简称。
ignored-files 通过正则表达式设置在编译时要忽略的文件,例如:emacs 相关文件。
post-per-page 如果启用了 post-preview(页面预览),那么在这里可以设置每个页面的预览条数。
blocks-per-preview 每个页面预览区块的显示条数,你也可以直接在 .md 或者 .asc 文件中通过 <!–more–> 标签设置页面预览区块。
previews? 设置为 true, 如果你想在主页只显示单条文章内容加最近发表内容列表,否则显示全部。更多讨论请看:这里
clean-urls? 设置为 true, 会为发布的 html 添加子目录。例如:prefix/root/page-name.html 被替换成 prefix/root/page-name/index.html。访问链接也会从 /page-name.html 变成 /page-name。默认为 true

除了以后这些配置选项之外,你也可以自己的配置选项。 例如,如果你想给你的博客文章加上副标题:

  1. 添加 :subtitle "My subtitle" 到配置文件。
  2. 通过 Selmer 模板引擎 {% subtitle %} 注入你的内容。
标签分类: cryogen