Mercurial > piecrust2

comparison README.md @ 3:f485ba500df3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Gigantic change to basically make PieCrust 2 vaguely functional. - Serving works, with debug window. - Baking works, multi-threading, with dependency handling. - Various things not implemented yet.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 10 Aug 2014 23:43:16 -0700
parents
children
comparison
equal deleted inserted replaced
2:40fa08b261b9 3:f485ba500df3
1 # PieCrust
2
3 ## Basic Configuration
4
5 PieCrust comes with a simple way to work with the 90% case: a personal website with a blog. You don't have anything to define, but you can customize some aspects of that default setup. From most likely to less likely:
6
7 * changing the URL format of posts
8 * changing the URL format of tags/categories
9 * defining new taxonomies (by default PieCrust comes with tags and categories)
10 * adding secondary blogs
11
12 ## Advanced Configuration
13
14 PieCrust defines content using 3 concepts: *sources*, *taxonomies*, and *routes*.
15
16 ### Sources
17
18 Sources define where your content is on disk, and how it's organized. By default, a source will use the `simple` scanner, but you can use other scanners that can can look for files differently, or can lift metadata information from the file names. For example, the `ordered` scanner will return the page files in the order defined by their file name prefix, and the `posts` collection of scanners will associate a date to each page based on their file name.
19
20 sources:
21 posts:
22 type: posts/flat
23 recipes
24 reviews:
25 type: ordered
26
27 ### Taxonomies
28
29 Taxonomies are used by PieCrust to generate listings of pages based on the metadata they have. For instance, you usually want pages listing posts for each existing tag.
30
31 taxonomies:
32 tags:
33 multiple: true
34 category
35 course
36 ingredients:
37 multiple: true
38
39 ### Routes
40
41 Routes define the shape of the URLs used to access your content. URLs for the built-in `pages` source cannot be changed, but you can specify URL routes for all custom sources and taxonomies.
42
43 routes:
44 /%year%/%month%/%slug%:
45 source: posts
46 /recipes/%slug%:
47 source: recipes
48 /recipes/tag/%value%:
49 source: recipes
50 taxonomy: tags
51 /recipes/ingredient/%value%:
52 source: recipes
53 taxonomy: ingredients
54 /reviews/%slug%:
55 source: reviews