Mercurial > piecrust2

annotate docs/config.yml @ 503:61d53d2163d6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Start a proper "code/API" section.
author Ludovic Chabant <ludovic@chabant.com>
date Thu, 23 Jul 2015 23:35:11 -0700
parents 2f4412745db2
children 0f777870fbaf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
243
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
1 # Basic stuff.
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
2 site:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
3 title: PieCrust
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
4 author: Ludovic Chabant
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
5 tagline: Freshly baked sites & documents since 2006
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
6 description: A static website generator and flat-file CMS
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
7 pretty_urls: true
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
8 sources:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
9 docs:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
10 type: ordered
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
11 data_endpoint: site.docs
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
12 default_layout: doc
503
61d53d2163d6 docs: Start a proper "code/API" section.
Ludovic Chabant <ludovic@chabant.com>
parents: 266
diff changeset
13 api:
61d53d2163d6 docs: Start a proper "code/API" section.
Ludovic Chabant <ludovic@chabant.com>
parents: 266
diff changeset
14 type: ordered
61d53d2163d6 docs: Start a proper "code/API" section.
Ludovic Chabant <ludovic@chabant.com>
parents: 266
diff changeset
15 data_endpoint: site.api
61d53d2163d6 docs: Start a proper "code/API" section.
Ludovic Chabant <ludovic@chabant.com>
parents: 266
diff changeset
16 default_layout: api
243
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
17 routes:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
18 -
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
19 url: /docs/%path:slug%
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
20 source: docs
245
64184c9cf487 docs: Fix URLs to the docs source.
Ludovic Chabant <ludovic@chabant.com>
parents: 243
diff changeset
21 func: docurl(slug)
503
61d53d2163d6 docs: Start a proper "code/API" section.
Ludovic Chabant <ludovic@chabant.com>
parents: 266
diff changeset
22 -
61d53d2163d6 docs: Start a proper "code/API" section.
Ludovic Chabant <ludovic@chabant.com>
parents: 266
diff changeset
23 url: /api/%path:slug%
61d53d2163d6 docs: Start a proper "code/API" section.
Ludovic Chabant <ludovic@chabant.com>
parents: 266
diff changeset
24 source: api
61d53d2163d6 docs: Start a proper "code/API" section.
Ludovic Chabant <ludovic@chabant.com>
parents: 266
diff changeset
25 func: apiurl(slug)
243
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
26
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
27 baker:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
28 assets_dirs:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
29 assets:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
30 # Ignore stuff that will get concatenated into the main JS file.
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
31 ignore: js/piecrust
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
32
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
33 smartypants:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
34 enable: true
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
35
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
36 # This is 2015, come on Markdown.
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
37 markdown:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
38 extensions: abbr, fenced_code, footnotes, smart_strong
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
39
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
40 # Need Foundation for CSS/JS. Install with Bower.
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
41 sass:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
42 load_paths:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
43 - bower_components/foundation/scss
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
44
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
45 # Using the Sass compiler directly now, but here's how it would look
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
46 # like if we were using the whole Compass machinery instead.
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
47 compass:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
48 enable: false
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
49 options: --css-dir %out_dir%/css --generated-images-path %out_dir%/img
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
50
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
51 # Config variants.
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
52 variants:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
53 # Enable compressors when baking the docs for publishing.
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
54 dist:
266
2f4412745db2 Temporary root URL for publishing.
Ludovic Chabant <ludovic@chabant.com>
parents: 245
diff changeset
55 site:
2f4412745db2 Temporary root URL for publishing.
Ludovic Chabant <ludovic@chabant.com>
parents: 245
diff changeset
56 root: /piecrust/v2/
243
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
57 baker:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
58 assets_dirs:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
59 assets:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
60 processors: all
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
61