# HG changeset patch # User Ludovic Chabant # Date 1424586358 28800 # Node ID 44ed3f49c011a6f374cb47fd54e4ccfdc17ca342 # Parent 9046361a6abbbe8e01e19521c37043f775942399 docs: Add website configuration page. diff -r 9046361a6abb -r 44ed3f49c011 docs/docs/02_general/03_website-configuration.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/docs/02_general/03_website-configuration.md Sat Feb 21 22:25:58 2015 -0800 @@ -0,0 +1,33 @@ +--- +title: Website Configuration +--- + +A PieCrust website can be configured by editing the `config.yml` file. This file +uses the [YAML][] syntax, which should be mostly straightforward: + + site: + title: My Fancy Blog + author: Ludovic + pretty_urls: true + posts_per_page: 10 + myblog: + something: foo + whatever: blah + +The above example defines two sections, `site` and `myblog`, with a bunch of +settings inside them. Sections can be nested at will, and settings can also be +defined at the root level. YAML is clever enough to convert things properly, +like `true` and `false` being converted to boolean values, or numbers being +treated as such. + +> Sometimes you may want to use some special characters like `&` or `'`, which +> are used for advanced things in YAML. If that ever causes some YAML parsing +> errors, just add double quotes around the setting. + +By convention, PieCrust's core systems only look for settings in the `site` +section. Other settings, like formatter or template engine specific settings, +will be found in other sections. + + +[yaml]: http://en.wikipedia.org/wiki/YAML +