Skip to content

Commit fa44ab8

Browse files
committed
Mention <highlight> feature, tidy up
1 parent bc38e5a commit fa44ab8

1 file changed

Lines changed: 17 additions & 5 deletions

File tree

docs/configuration.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuration
22

3-
## Project Structure
3+
## Example Project Structure
44

55
```
66
project/
@@ -17,7 +17,7 @@ project/
1717
└── templates/
1818
```
1919

20-
## Configuration Reference
20+
## Main Configuration File
2121

2222
| Option | Type | Default | Description |
2323
| ----------------- | ------- | ------------ | ------------------------------------------------------------------------------------------------------------------ |
@@ -27,22 +27,28 @@ project/
2727
| `compress_pdf` | boolean | `false` | Whether to compress the final PDF. Requires Ghostscript. |
2828
| `svg2pdf_backend` | string | `"cairosvg"` | Backend to use for SVG to PDF conversion. `"cairosvg"` is built-in, `"inkscape"` requires Inkscape to be installed |
2929

30+
You can use `<highlight>text</highlight>` tags in your templates, and they will be
31+
highlighted in the color specified by the `highlight_colour` in your `style`.
32+
3033
Example:
3134

3235
```yaml
36+
# kiwipycon.yml
37+
3338
documents:
3439
- prospectus
3540
- material_specs
3641

3742
style:
38-
highlight_colour: primary
43+
highlight_colour: teal # Color for <highlight>text</highlight> tags
3944
font_family: "Helvetica Neue"
40-
heading_size: large
41-
spacing: normal
45+
heading_size: large # from theme
46+
spacing: normal # from theme
4247

4348
theme:
4449
primary: "#30987c"
4550
secondary: "#2c3e50"
51+
teal: "#30987c"
4652
large: "24pt"
4753
normal: "12pt"
4854
small: "10pt"
@@ -75,6 +81,7 @@ Example:
7581

7682
```yaml
7783
# prospectus/config.yml
84+
7885
filename: "Kiwi PyCon {{ conference.year }} - Prospectus"
7986
compress_pdf: true # Override the main config
8087
@@ -98,6 +105,7 @@ Example:
98105

99106
```yaml
100107
# pages/conference_schedule.yml
108+
101109
template: list_section.svg.j2
102110
103111
# Override global style settings
@@ -169,6 +177,10 @@ The entire merged configuration is available to your templates. This means:
169177
| `images` | List of image objects, each with `name` and `type` (as specified) and also `data` (base64-encoded data for inclusion in the page) |
170178
| Any other keys | All other configuration is passed through as-is |
171179

180+
You can use `<highlight>text</highlight>` tags in your templates, and they will be
181+
highlighted in the color specified by the `highlight_colour` in your `style` (see "Main
182+
Configuration File" above). |
183+
172184
## Document Variants
173185

174186
Create multiple versions of a document by defining variants in the document

0 commit comments

Comments
 (0)