docs/config.md (1943 bytes)
1 # Configuration 2 3 ## Where 4 5 Coleslaw needs a `.coleslawrc` file to operate properly. That file is usually located at 6 $HOME/.coleslawrc but may also be placed in the blog repo itself. 7 8 ## What 9 10 The only *required* information in the config is: 11 * `:author` => to be placed on post pages and in the copyright/CC-BY-SA notice 12 * `:deploy-dir` => for Coleslaw's generated HTML to go in 13 * `:domain` => to generate absolute links to the site content 14 * `:routing` => to determine the URL scheme of content on the site 15 * `:title` => to provide a site title 16 * `:theme` => to select one of the themes in "coleslaw/themes/" 17 18 It is usually recommend to start from the [example config][ex_config] and pare down from there. 19 20 [ex_config]: https://github.com/redline6561/coleslaw/blob/master/examples/example.coleslawrc 21 22 ## Extras 23 24 There are also many *optional* config parameters such as: 25 * `:charset` => to set HTML attributes for international characters, default: "UTF-8" 26 * `:feeds` => to generate RSS and Atom feeds for certain tagged content 27 * `:excerpt-sep` => to set the separator for excerpt in content, default: `<!--more-->` 28 * `:lang` => to set HTML attributes indicating the site language, default: "en" 29 * `:license` => to override the displayed content license, the default is CC-BY-SA 30 * `:page-ext` => to set the suffix of generated files, default: "html". "" for no extension 31 * `:plugins` => to configure and enable coleslaw's [various plugins][plugin-use] 32 * `:separator` => to set the separator for content metadata, default: ";;;;;" 33 * `:sitenav` => to provide relevant links and ease navigation 34 * `:staging-dir` => for Coleslaw to do intermediate work, default: "/tmp/coleslaw" 35 * `:title-fn` => to modify document slugs after they are generated, default: `'identity` 36 37 [plugin-use]: https://github.com/redline6561/coleslaw/blob/master/docs/plugin-use.md