diff --git a/site/_posts/2012-07-01-configuration.md b/site/_posts/2012-07-01-configuration.md index a942914b..6a66e14c 100644 --- a/site/_posts/2012-07-01-configuration.md +++ b/site/_posts/2012-07-01-configuration.md @@ -9,6 +9,8 @@ Jekyll allows you to concoct your sites in any way you can dream up, and it’s ## Configuration Settings +### Global Configuration + The table below lists the available settings for Jekyll, and the various options (specifed in the configuration file) and flags (specified on the command-line) that control them. @@ -19,6 +21,26 @@ The table below lists the available settings for Jekyll, and the various + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
+

Site Source

+

Changes the directory where Jekyll will look to transform files

+
+

source: [string]

+

--source [source]

+
+

Site Destination

+

Changes the directory where Jekyll will write files to

+
+

destination: [string]

+

--destination

+

Safe

@@ -29,140 +51,6 @@ The table below lists the available settings for Jekyll, and the various --safe

-

Regeneration

-

Enables or disables Jekyll from recreating the site when files are modified.

-
-

auto: [boolean]

-

--auto

-

--no-auto

-
-

Local Server

-

Fires up a server that will host your _site directory

-
-

server: [boolean]

-

--server

-
-

Local Server Port

-

Changes the port that the Jekyll server will run on

-
-

server_port: [integer]

-

--server [port]

-
-

Base URL

-

Serve website from a given base URL

-
-

baseurl: [BASE_URL]

-

--base-url [url]

-
-

URL

-

Sets site.url, useful for environment switching

-
-

url: [URL]

-

--url [URL]

-
-

Site Destination

-

Changes the directory where Jekyll will write files to

-
-

destination: [dir]

-

jekyll [dest]

-
-

Site Source

-

Changes the directory where Jekyll will look to transform files

-
-

source: [dir]

-

jekyll [source] [dest]

-
-

Markdown

-

Uses RDiscount or [engine] instead of Maruku.

-
-

markdown: [engine]

-

--rdiscount

-

--kramdown

-

--redcarpet

-
-

Pygments

-

Enables highlight tag with Pygments.

-
-

pygments: [boolean]

-

--pygments

-
-

Future

-

Publishes posts with a future date

-
-

future: [boolean]

-

--no-future

-

--future

-
-

LSI

-

Produces an index for related posts.

-
-

lsi: [boolean]

-

--lsi

-
-

Permalink

-

Controls the URLs that posts are generated with. Please refer to the Permalinks page for more info.

-
-

permalink: [style]

-

--permalink=[style]

-
-

Pagination

-

Splits your posts up over multiple subdirectories called "page2", "page3", ... "pageN"

-
-

paginate: [per_page]

-

--paginate [per_page]

-

Exclude

@@ -181,6 +69,98 @@ The table below lists the available settings for Jekyll, and the various include: [dir1, file1, dir2]

+ +### Configuration for "build" Sub-Command + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SettingOptions and Flags
+

Regeneration

+

Enables auto-regeneration of the site when files are modified. Off by default.

+
+

--watch

+
+

URL

+

Sets site.url, useful for environment switching

+
+

url: [URL]

+

--url [URL]

+
+

Markdown

+

Uses RDiscount or [engine] instead of Maruku.

+
+

markdown: [engine]

+

--markdown [rdiscount|kramdown|redcarpet]

+
+

Pygments

+

Enables highlight tag with Pygments.

+
+

pygments: [boolean]

+

--pygments

+
+

Future

+

Publishes posts with a future date

+
+

future: [boolean]

+

--future

+
+

LSI

+

Produces an index for related posts.

+
+

lsi: [boolean]

+

--lsi

+
+

Permalink

+

Controls the URLs that posts are generated with. Please refer to the Permalinks page for more info.

+
+

permalink: [style]

+

--permalink [style]

+
+

Pagination

+

Splits your posts up over multiple subdirectories called "page2", "page3", ... "pageN"

+
+

paginate: [per_page]

+

--paginate [per_page]

+

Limit Posts

@@ -188,10 +168,56 @@ The table below lists the available settings for Jekyll, and the various

limit_posts: [max_posts]

-

--limit_posts=[max_posts]

+

--limit_posts [max_posts]

+### Configuration for "serve" Sub-Command + +In addition to the options below, the `serve` sub-command can accept any of the options +for the `build` sub-command, which are then applied to the site build which occurs right +before your site is served. + + + + + + + + + + + + + + + + + + + + +
SettingOptions and Flags
+

Local Server Port

+

Changes the port that the Jekyll server will run on

+
+

port: [integer]

+

--port [port]

+
+

Local Server Hostname

+

Changes the hostname that the Jekyll server will run on

+
+

host: [string]

+

--host [hostname]

+
+

Base URL

+

Serve website from a given base URL

+
+

baseurl: [BASE_URL]

+

--baseurl [url]

+
@@ -206,9 +232,10 @@ Jekyll runs with the following configuration options by default. Unless alternat {% highlight yaml %} safe: false -auto: false +watch: false server: false -server_port: 4000 +host: 0.0.0.0 +port: 4000 baseurl: / url: http://localhost:4000