public
Description: Jekyll is a blog-aware, static site generator in Ruby
Home | Edit | New

Configuration

Jekyll allows you to concoct your sites in any way you can dream up. The following is a list of the currently supported configuration options. These can all be specified by creating a _config.yml file in your site’s root directory. There are also flags for the jekyll executable which are described below next to their respective configuration options. The order of precedence for conflicting settings is this:

  1. Command-line flags
  2. Configuration file settings
  3. Defaults

Configuration Settings

Setting Config Flag Description
Regeneration
auto: [boolean]
--no-auto --auto Enables or disables Jekyll from recreating the site when files are modified.
Local Server
server: [boolean]
--server Fires up a server that will host your _site directory
Local Server Port
server_port: [integer]
--server [port] Changes the port that the Jekyll server will run on
Site Destination
destination: [dir]
jekyll [dest]
Changes the directory where Jekyll will write files to
Site Source
source: [dir]
jekyll [source] [dest]
Changes the directory where Jekyll will look to transform files
Markdown
markdown: [engine]
--rdiscount Uses RDiscount or [engine] instead of Maruku.
Pygments
pygments: [boolean]
--pygments Enables highlight tag with Pygments.
LSI
lsi: [boolean]
--lsi Produces an index for related posts.
Permalink
permalink: [style]
--permalink=[style] Controls the URLs that posts are generated with. Please refer to the Permalinks page for more info.
Pagination
paginate: [per_page]
--paginate [per_page] Splits your posts up over multiple subdirectories called “page2”, “page3”, … “pageN”

Default Configuration

destination: ./_site
auto:        false
lsi:         false
server_port: 4000
pygments:    false
markdown:    maruku
permalink:   date
maruku:
  use_tex:    false
  use_divs:   false
  png_dir:    images/latex
  png_url:    /images/latex
Last edited by qrush, Wed Oct 28 23:08:22 -0700 2009
Home | Edit | New
Versions: