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
Safe	safe: [boolean]	--safe	Disables custom plugins.
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
Base URL	baseurl: [BASE_URL]	--base-url [url]	Serve website from a given base URL
URL	url: [URL]	--url [url]	Sets site.url, useful for environment switching
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 or --kramdown or --redcarpet	Uses RDiscount or [engine] instead of Maruku.
Pygments	pygments: [boolean]	--pygments	Enables highlight tag with Pygments.
Future	future: [boolean]	--no-future --future	Publishes posts with a future date
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”
Exclude	exclude: [dir1, file1, dir2]		A list of directories and files to exclude from the conversion
Include	include: [dir1, file1, dir2]		A list of directories and files to specifically include in the conversion. .htaccess is a good example since dotfiles are excluded by default.
Limit Posts	limit_posts: [max_posts]	--limit_posts=[max_posts]	Limits the number of posts to parse and publish

Default Configuration

Note — You cannot use tabs in configuration files. This will either lead to parsing errors, or Jekyll will use the default settings.

safe:        false
auto:        false
server:      false
server_port: 4000
baseurl:    /
url: http://localhost:4000

source:      .
destination: ./_site
plugins:     ./_plugins

future:      true
lsi:         false
pygments:    false
markdown:    maruku
permalink:   date

maruku:
  use_tex:    false
  use_divs:   false
  png_engine: blahtex
  png_dir:    images/latex
  png_url:    /images/latex

rdiscount:
  extensions: []

kramdown:
  auto_ids: true,
  footnote_nr: 1
  entity_output: as_char
  toc_levels: 1..6
  use_coderay: false
  
  coderay:
    coderay_wrap: div
    coderay_line_numbers: inline
    coderay_line_numbers_start: 1
    coderay_tab_width: 4
    coderay_bold_every: 10
    coderay_css: style