1.8 KiB
1.8 KiB
Configuration
Where
Coleslaw needs a .coleslawrc file to operate properly. That file is usually located at
$HOME/.coleslawrc but may also be placed in the blog repo itself.
What
The only required information in the config is:
:author=> to be placed on post pages and in the copyright/CC-BY-SA notice:deploy-dir=> for Coleslaw's generated HTML to go in:domain=> to generate absolute links to the site content:routing=> to determine the URL scheme of content on the site:title=> to provide a site title:theme=> to select one of the themes in "coleslaw/themes/"
TODO Make sure this is actually true. Maybe without :feeds the publish method blows up? Test!
It is usually recommend to start from the example config and pare down from there.
Extras
There are also many optional config parameters such as:
:charset=> to set HTML attributes for international characters, default: "UTF-8":feeds=> to generate RSS and Atom feeds for certain tagged content:lang=> to set HTML attributes indicating the site language, default: "en":license=> to override the displayed content license, the default is CC-BY-SA:page-ext=> to set the suffix of generated files, default: "html":plugins=> to configure and enable coleslaw's various plugins:separator=> to set the separator for content metadata, default: ";;;;;":sitenav=> to provide relevant links and ease navigation:staging-dir=> for Coleslaw to do intermediate work, default: "/tmp/coleslaw"