From b79bbfdb9283007014d965f06a657f8fb15bed2f Mon Sep 17 00:00:00 2001 From: Steve Persch Date: Tue, 29 Oct 2013 17:27:16 -0500 Subject: [PATCH 1/2] Adding sculpin_kernel.md --- source/documentation/app_files/sculpin_kernel.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 source/documentation/app_files/sculpin_kernel.md diff --git a/source/documentation/app_files/sculpin_kernel.md b/source/documentation/app_files/sculpin_kernel.md new file mode 100644 index 0000000..15b4db4 --- /dev/null +++ b/source/documentation/app_files/sculpin_kernel.md @@ -0,0 +1,9 @@ +--- +layout: default +title: sculpin_kernel.yml + +--- + +sculpin_kernel.yml +================== + From b8eaef0a47e3fc0ffaedffa42496b44337f1f5b3 Mon Sep 17 00:00:00 2001 From: Steve Persch Date: Tue, 29 Oct 2013 18:06:38 -0500 Subject: [PATCH 2/2] Starting on documentation of raw/exclude/ignore options in sculpin_kernel.yml --- .../documentation/app_files/sculpin_kernel.md | 53 ++++++++++++++++++- 1 file changed, 51 insertions(+), 2 deletions(-) diff --git a/source/documentation/app_files/sculpin_kernel.md b/source/documentation/app_files/sculpin_kernel.md index 15b4db4..84e6ca1 100644 --- a/source/documentation/app_files/sculpin_kernel.md +++ b/source/documentation/app_files/sculpin_kernel.md @@ -4,6 +4,55 @@ title: sculpin_kernel.yml --- -sculpin_kernel.yml -================== +# sculpin_kernel.yml +Some parts of Sculpin, specifically anything configured as a bundle, must be +configured at the kernel level. This can be done by modifying the +`sculpin_kernel.yml` file. + + |-- app/ + | `-- config/ + | `-- sculpin_kernel.yml # Sculpin's configuration (optional) + + +For example, to configure something like the default permalink for posts, one +would need to configure the posts bundle's configuration: + + sculpin_posts: + permalink: blog/:year/:month/:day/:filename/ + +Or if one wanted to change the default Markdown parser class, one would: + + sculpin_markdown: + parser_class: Michelf\Markdown + +## Additional Examples + +Here is an incomplete list of of example overrides that can be done through sculpin_kernel.yml + +~~~ +sculpin: + # Paths marked as 'raw' are not processed by Sculpin at all and are copied + # straight to the output directory. The "raw" designation is useful in case + # something like compressed javascript or compressed css that would otherwise + # be mangled. + raw: + - "path/to/raw/code" + - "another/directory/of/raw/code" + # Excluded files are not copied to the output directory yet still trigger + # a rebuild out the output site. The Twig bundle adds the '_views' directory + # to this list because these files do not need to be on a production website + # yet changes to those files alter the output of the site. + exclude: + # Sass code doesn't need to be sent to the live server. + - "code/_sass/" + # @todo I don't know why the "*" is needed in this path to make the file + # actually be excluded but it is. + - "code/config.rb*" + # Paths marked as "ignore" will be ignored by Sculpin and not copied to the + # output directory. Unlike "exclude," changes to paths under "ignore" will not + # trigger Sculpin rebuilds. + ignore: + - "ignore/this/directory" + - "ignore/this/pattern_*" +~~~