This repository has been archived by the owner on Mar 15, 2021. It is now read-only.
/
config.php
298 lines (267 loc) · 10.6 KB
/
config.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<?php
/*
Maizzle - Email Development Framework
A project by Cosmin Popovici (@cossssmin) and ThemeMountain (@thememountainco).
Welcome to the Maizzle config file. This is where you can customise some
Maizzle settings for your project.
View the full documentation at https://maizzle.com/docs
|-------------------------------------------------------------------------------
| The default config https://maizzle.com/docs/building/#local
|-------------------------------------------------------------------------------
|
| This array contains the default Maizzle settings for development. This is
| used when you run the `npm run dev` or `npm run watch` commands.
|
*/
return [
/*
|-----------------------------------------------------------------------------
| Layout https://maizzle.com/docs/layouts/
|-----------------------------------------------------------------------------
|
| Define a master layout that all templates will extend by default.
|
| Maizzle comes with a default layout that sets various tags to
| use settings from your config, but you can of course create
| your own layouts and extend them at a template level,
| with front matter.
|
*/
'extends' => '_layouts.master',
/*
|-----------------------------------------------------------------------------
| Doctype https://maizzle.com/docs/configuration/#doctype
|-----------------------------------------------------------------------------
|
| Define a doctype that will be used in the layout your emails extend.
|
| Maizzle defines an HTML 5 doctype by default, but you can choose
| any doctype you need. You can also override it for each email,
| through a front matter variable. If you use an empty string,
| Maizzle's layouts will fallback to `html`.
|
*/
'doctype' => 'html',
/*
|-----------------------------------------------------------------------------
| Language https://maizzle.com/docs/configuration/#language
|-----------------------------------------------------------------------------
|
| This will be used in the `lang=""` attribute of the `<html>` tag. It helps
| screen reader software use the correct pronunciation. Of course, you can
| override it in each template, with front matter variables.
|
*/
'language' => 'en',
/*
|-----------------------------------------------------------------------------
| Character set https://maizzle.com/docs/configuration/#charset
|-----------------------------------------------------------------------------
|
| Character encoding is set to UTF-8 by default. This prevents breaking
| reading patterns by ensuring proper character rendering, both
| on-screen and with screen readers.
|
*/
'charset' => 'utf8',
/*
|-----------------------------------------------------------------------------
| Document title https://maizzle.com/docs/configuration/#title
|-----------------------------------------------------------------------------
|
| The `<title>` tag is needed in order to give screen reader users context.
| It also helps when viewing the email in a browser (like your email's
| online version), by setting the title on the browser's tab.
|
| You should specify a `title` key in the front matter for each email.
|
*/
'title' => '',
/*
|-----------------------------------------------------------------------------
| Google Fonts https://maizzle.com/docs/configuration/#google-fonts
|-----------------------------------------------------------------------------
|
| This is where you can define which Google Fonts Maizzle should import.
|
| It will only import Google Fonts by adding a `<link>` tag to your HTML.
| In order to use them, you still need to register the .font-{name}
| class in the tailwind.js config file. Use as few fonts and
| weights as possible, because it affects load time.
|
| Example:
|
| 'googleFonts' => [
| 'Open+Sans:300,400,700',
| 'Merriweather',
| ],
|
*/
'googleFonts' => [],
/*
|-----------------------------------------------------------------------------
| Screenshots https://maizzle.com/docs/building/#screenshots
|-----------------------------------------------------------------------------
|
| This is where you can define which devices Puppeteer should emulate when
| using the `screenshots` command in Maizzle. iPad Mini and iPhone 6 are
| enabled by default, but you can use any of the device descriptors
| supported by Puppeteer.
|
| It is recommended that you use as few devices as possible, as this
| process launches Chrome in headless mode and, the more devices
| you use, the more time it will take to generate screenshots.
|
| Note that these only emulate the viewport of a device, they are not
| intended for email client render tests.
|
*/
'screenshots' => [
'devices' => [
'iPad Mini',
'iPhone 6',
],
'type' => 'png',
'quality' => 100,
],
/*
|-----------------------------------------------------------------------------
| Transformers https://maizzle.com/docs/configuration/#transformers
|-----------------------------------------------------------------------------
|
| This is where you can define various transformations that will be applied
| to the output files. To speed up development, Maizzle disables most of
| them for local development. They are, however, enabled in the
| staging and production environment configs.
|
| Don't let the output file size scare you when working locally. Having
| transformations disabled, you can reference any Tailwind CSS class
| when debugging in-browser, and rapidly prototype your emails.
|
| Some of the advanced minifier options are not exposed here, but you
| can customise them in tasks/js/after-jigsaw.js.
|
*/
'transformers' => [
'baseImageURL' => '',
'inlineCSS' => [
'enabled' => false,
'styleToAttribute' => [
'background-color' => 'bgcolor',
'background-image' => 'background',
'text-align' => 'align',
'vertical-align' => 'valign',
],
'applySizeAttribute' => [
'width' => ['TABLE', 'TD', 'TH', 'IMG', 'VIDEO'],
'height' => ['TABLE', 'TD', 'TH', 'IMG', 'VIDEO'],
],
'excludedProperties' => [],
],
'cleanup' => [
'removeUnusedCss' => [
'enabled' => false,
'whitelist' => [
".External*",
".ReadMsgBody",
".yshortcuts",
".Mso*",
"#outlook",
],
'backend' => [
[
'heads' => "{{",
'tails' => "}}",
],
],
'removeHTMLComments' => [
'enabled' => true,
'preserve' => ['if', 'endif', 'mso', 'ie'],
],
'uglifyClassNames' => true,
],
'keepOnlyAttributeSizes' => [
'width' => ['TABLE', 'TD', 'TH', 'IMG', 'VIDEO'],
'height' => ['TABLE', 'TD', 'TH', 'IMG', 'VIDEO'],
],
'preferBgColorAttribute' => false,
],
'prettify' => false,
'minify' => [
'minifyCSS' => false,
'maxLineLength' => false,
'preserveLineBreaks' => false,
'collapseWhitespace' => false,
'conservativeCollapse' => false,
],
'sixHex' => false,
'altText' => false,
],
/*
|-----------------------------------------------------------------------------
| Plaintext https://maizzle.com/docs/configuration/#plaintext
|-----------------------------------------------------------------------------
|
| When this option is set to true, Maizzle will generate a plaintext version
| for every template. The .txt file will be placed in the same directory
| as the HTML it's based on, and it will also have the same name.
|
*/
'plaintext' => false,
/*
|-----------------------------------------------------------------------------
| BrowserSync https://maizzle.com/docs/configuration/#browsersync
|-----------------------------------------------------------------------------
|
| Tunnel
|
| When running the `watch` command with `tunnel` set to `true`, BrowserSync
| will create a tunnel to your localhost, via localtunnel.me. You can
| use this URL to share a live preview of what you're working
| on with a colleague or a client.
|
| By default, setting it to `true` will generate a random localtunnel.me
| subdomain. You can use a string instead, to have BrowserSync attempt
| to use a custom subdomain.
|
| Directory listing
|
| Setting the `listing` option to `true` will enable a directory listing
| when running the `watch` command, so you can browse through your
| emails. You might want to set it to `false` when using the
| tunnel option with a client.
|
*/
'browsersync' => [
'tunnel' => false,
'listing' => false,
],
/*
|-----------------------------------------------------------------------------
| Helpers https://maizzle.com/docs/configuration/#helpers
|-----------------------------------------------------------------------------
|
| Jigsaw config functions used by Maizzle in the build process.
|
*/
'googleFontsString' => function($page) {
return collect($page->googleFonts)->transform(function($item, $key) {
return str_replace(' ', '+', $item);
})->implode('|');
},
/*
|-----------------------------------------------------------------------------
| Build defaults https://maizzle.com/docs/configuration/#build-defaults
|-----------------------------------------------------------------------------
|
| Configure additional Jigsaw build settings.
|
*/
'baseUrl' => '',
'pretty' => false,
'production' => false,
'build' => [
'source' => 'source',
'destination' => 'build_local',
],
];