changeset 270:935bf5682686

docs: Add information about the asset pipeline.
author Ludovic Chabant <ludovic@chabant.com>
date Fri, 27 Feb 2015 22:30:36 -0800
parents dbd6813fb6df
children 12657039c436
files docs/docs/02_general/04_how-it-works.md
diffstat 1 files changed, 27 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/docs/02_general/04_how-it-works.md	Wed Feb 25 23:10:37 2015 -0800
+++ b/docs/docs/02_general/04_how-it-works.md	Fri Feb 27 22:30:36 2015 -0800
@@ -107,14 +107,41 @@
 * [Formatting][fmt], with [Markdown][] or [Textile][].
 
 
+## Asset pipeline
+
+PieCrust comes with a very capable built-in asset pipeline to process your CSS
+and Javscript files, images, etc. It works very well for common use-cases, since
+it doesn't require any kind of configuration -- unlike other more powerful
+systems like [Grunt][] or [Gulp][].
+
+The PieCrust asset pipeline matches files to *processors*, in a recursive way --
+which means the _outputs_ of a given processor are then potentially re-processed
+by others processors.
+
+For instance, if you have a [Less CSS file][less], it will be processed like so:
+
+    foo.less   ->   foo.css  ->  foo.min.css
+
+Any LessCSS file (_i.e._ a file with the `.less` extension) will be compiled with
+the LessCSS processor, which outputs a CSS file. This then gets picked up by
+the CleanCSS processor, which will generate a compressed CSS file.
+
+If you want more information about what processors are mapped to what file
+types, you can check the list of [built-in processors][procs].
+
+
 [src]: {{docurl('content-model/sources')}}
 [def]: {{docurl('content-model/default-model')}}
 [seg]: {{docurl('content/content-segments')}}
 [tpl]: {{docurl('content/templating')}}
 [fmt]: {{docurl('content/formatters')}}
+[procs]: {{docurl('reference/asset-pipeline')}}
 [siteconf]: {{docurl('general/website-configuration')}}
 [pageconf]: {{docurl('content/page-configuration')}}
 [jinja]: http://jinja.pocoo.org/docs/dev/templates/
 [markdown]: https://en.wikipedia.org/wiki/Markdown
 [textile]: https://en.wikipedia.org/wiki/Textile_(markup_language)
+[grunt]: http://gruntjs.com/
+[gulp]: http://gulpjs.com/
+[less]: http://lesscss.org/