annotate docs/config.yml @ 1195:ae9387338db1 draft default tip

admin: add option to publish immediately
author Ludovic Chabant <ludovic@chabant.com>
date Fri, 30 Dec 2022 16:48:04 -0800
parents 40228511d600
children
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 -
795
922092c6eb8a docs: Fix outdated routing in the configuration file.
Ludovic Chabant <ludovic@chabant.com>
parents: 667
diff changeset
19 url: /docs/%slug%
243
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
20 source: docs
795
922092c6eb8a docs: Fix outdated routing in the configuration file.
Ludovic Chabant <ludovic@chabant.com>
parents: 667
diff changeset
21 func: docurl
503
61d53d2163d6 docs: Start a proper "code/API" section.
Ludovic Chabant <ludovic@chabant.com>
parents: 266
diff changeset
22 -
795
922092c6eb8a docs: Fix outdated routing in the configuration file.
Ludovic Chabant <ludovic@chabant.com>
parents: 667
diff changeset
23 url: /api/%slug%
503
61d53d2163d6 docs: Start a proper "code/API" section.
Ludovic Chabant <ludovic@chabant.com>
parents: 266
diff changeset
24 source: api
795
922092c6eb8a docs: Fix outdated routing in the configuration file.
Ludovic Chabant <ludovic@chabant.com>
parents: 667
diff changeset
25 func: apiurl
243
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
26
1116
40228511d600 chef: Add new `chef/env` config section.
Ludovic Chabant <ludovic@chabant.com>
parents: 1074
diff changeset
27 chef:
40228511d600 chef: Add new `chef/env` config section.
Ludovic Chabant <ludovic@chabant.com>
parents: 1074
diff changeset
28 env:
40228511d600 chef: Add new `chef/env` config section.
Ludovic Chabant <ludovic@chabant.com>
parents: 1074
diff changeset
29 PATH: node_modules/.bin
40228511d600 chef: Add new `chef/env` config section.
Ludovic Chabant <ludovic@chabant.com>
parents: 1074
diff changeset
30
243
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
31 baker:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
32 assets_dirs:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
33 assets:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
34 # 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
35 ignore: js/piecrust
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
36
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
37 # This is 2015, come on Markdown.
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
38 markdown:
509
0f777870fbaf docs: Configure fenced code blocks in Markdown with Pygments highlighting.
Ludovic Chabant <ludovic@chabant.com>
parents: 503
diff changeset
39 extensions: abbr, fenced_code, footnotes, smart_strong, codehilite, smarty
0f777870fbaf docs: Configure fenced code blocks in Markdown with Pygments highlighting.
Ludovic Chabant <ludovic@chabant.com>
parents: 503
diff changeset
40 extension_configs:
0f777870fbaf docs: Configure fenced code blocks in Markdown with Pygments highlighting.
Ludovic Chabant <ludovic@chabant.com>
parents: 503
diff changeset
41 codehilite:
0f777870fbaf docs: Configure fenced code blocks in Markdown with Pygments highlighting.
Ludovic Chabant <ludovic@chabant.com>
parents: 503
diff changeset
42 css_class: highlight
0f777870fbaf docs: Configure fenced code blocks in Markdown with Pygments highlighting.
Ludovic Chabant <ludovic@chabant.com>
parents: 503
diff changeset
43 guess_lang: false
243
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
44
1053
94d7d5e38571 docs: Upgrade to Bootstrap 4 and Sass.
Ludovic Chabant <ludovic@chabant.com>
parents: 795
diff changeset
45 # Need Bootstrap.
243
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
46 sass:
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
47 load_paths:
1053
94d7d5e38571 docs: Upgrade to Bootstrap 4 and Sass.
Ludovic Chabant <ludovic@chabant.com>
parents: 795
diff changeset
48 - ../node_modules/bootstrap/scss
243
26e59f837558 docs: Add embryo of a documentation website.
Ludovic Chabant <ludovic@chabant.com>
parents:
diff changeset
49