-
Notifications
You must be signed in to change notification settings - Fork 1
/
config.js
334 lines (290 loc) · 9.66 KB
/
config.js
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
/*
Maizzle - Email Development Framework
Welcome to the Maizzle config file. This is where you can customize Maizzle
for your project. Besides changing some values here and there, you can
also write custom functions and even require packages - it's all
just a JavaScript file that exports a `config` object.
View the full documentation at https://maizzle.com
*/
/*
|-------------------------------------------------------------------------------
| Development config https://maizzle.com/docs/environments/#local
|-------------------------------------------------------------------------------
|
| The `config` object contains the default Maizzle settings for development.
| This is used when you run the `maizzle build` or `maizzle serve`
| and it's the fastest, as most transformations are disabled.
|
*/
module.exports = {
/*
|-----------------------------------------------------------------------------
| Doctype https://maizzle.com/docs/doctype/
|-----------------------------------------------------------------------------
|
| Define a global doctype to be used in the master Layout.
|
*/
doctype: 'html',
/*
|-----------------------------------------------------------------------------
| Language https://maizzle.com/docs/language/
|-----------------------------------------------------------------------------
|
| Set a global `lang=""` attribute for the `<html>` tag in the master Layout.
|
*/
language: 'en',
/*
|-----------------------------------------------------------------------------
| Character set https://maizzle.com/docs/charset/
|-----------------------------------------------------------------------------
|
| Set a global character encoding. Also used in the master Layout.
|
*/
charset: 'utf-8',
/*
|-----------------------------------------------------------------------------
| Google Fonts https://maizzle.com/docs/google-fonts/
|-----------------------------------------------------------------------------
|
| This is where you can define which Google Fonts Maizzle should import.
|
*/
googleFonts: '',
/*
|-----------------------------------------------------------------------------
| Base Image URL https://maizzle.com/docs/base-image-url/
|-----------------------------------------------------------------------------
|
| The URL you define here will be prepended to all image `src=""` values,
| as well as all background images (attributes and inline CSS).
|
*/
baseImageURL: '',
/*
|-----------------------------------------------------------------------------
| CSS Inlining https://maizzle.com/docs/css-inlining/
|-----------------------------------------------------------------------------
|
| Control how CSS is inlined in your templates. Maizzle uses Juice for
| inlining, and exposes some of its options to your config.
|
*/
inlineCSS: {
enabled: true,
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: null,
},
/*
|-----------------------------------------------------------------------------
| Code Clean-up https://maizzle.com/docs/code-cleanup/
|-----------------------------------------------------------------------------
|
| Various options for cleaning up and optimizing your email's CSS and markup.
|
*/
cleanup: {
/*
|-----------------------------------------------------------------------------
| PurgeCSS https://maizzle.com/docs/code-cleanup/#purgecss
|-----------------------------------------------------------------------------
|
| PurgeCSS will remove unused CSS selectors. This takes place *before*
| CSS inlining and `removeUnusedCSS`.
|
*/
purgeCSS: {
content: [
'src/layouts/**/*.*',
'src/partials/**/*.*',
'src/components/**/*.*',
],
whitelist: [],
whitelistPatterns: [],
},
/*
|-----------------------------------------------------------------------------
| CSS Clean-up https://maizzle.com/docs/code-cleanup/#removeunusedcss
|-----------------------------------------------------------------------------
|
| Options in `removeUnusedCSS` are passed directly to `email-comb`, which
| can remove unused CSS and HTML comments, and even uglify class names.
|
| Enable this in any non-local environment config.
|
*/
removeUnusedCSS: {
enabled: true,
},
/*
|-----------------------------------------------------------------------------
| Replace strings
| https://maizzle.com/docs/code-cleanup/#replacestrings
|-----------------------------------------------------------------------------
|
| Regular expressions [key] and the string to replace them with [value].
|
*/
replaceStrings: false,
/*
|-----------------------------------------------------------------------------
| Keep Only Attribute Sizes
| https://maizzle.com/docs/code-cleanup/#keeponlyattributesizes
|-----------------------------------------------------------------------------
|
| Define for which elements Maizzle should only keep attribute sizes, like
| `width=""` and `height=""`. Elements in these arrays will have their
| inline CSS widths and heights removed.
|
*/
keepOnlyAttributeSizes: {
width: ['TABLE', 'TD', 'TH', 'IMG', 'VIDEO'],
height: ['TABLE', 'TD', 'TH', 'IMG', 'VIDEO'],
},
/*
|-----------------------------------------------------------------------------
| Prefer bgcolor Attribute
| https://maizzle.com/docs/code-cleanup/#preferbgcolorattribute
|-----------------------------------------------------------------------------
|
| When set to `true`, Maizzle will remove `background-color` inline CSS.
|
*/
preferBgColorAttribute: false,
},
/*
|-----------------------------------------------------------------------------
| Extra Attributes https://maizzle.com/docs/extra-attributes/
|-----------------------------------------------------------------------------
|
| Defines which elements should receive which attributes with what values.
|
*/
applyExtraAttributes: {
table: {
cellpadding: 0,
cellspacing: 0,
role: 'presentation',
},
img: {
alt: ''
}
},
/*
|-----------------------------------------------------------------------------
| URL Parameters https://maizzle.com/docs/url-parameters/
|-----------------------------------------------------------------------------
|
| Define global URL parameters to append to all links in all templates.
|
*/
urlParameters: {},
/*
|-----------------------------------------------------------------------------
| Prettify https://maizzle.com/docs/prettify/
|-----------------------------------------------------------------------------
|
| Enable pretty printing your email code. Use if sending HTML to a human.
|
*/
prettify: {
enabled: false,
indent_inner_html: false,
ocd: true,
},
/*
|-----------------------------------------------------------------------------
| Minify https://maizzle.com/docs/minify/
|-----------------------------------------------------------------------------
|
| Enable and configure minifier options. Enable for production builds.
|
*/
minify: {
enabled: false,
},
/*
|-----------------------------------------------------------------------------
| BrowserSync https://maizzle.com/docs/browsersync/
|-----------------------------------------------------------------------------
|
| Configure BrowserSync options.
|
*/
browsersync: {
directory: true,
notify: false,
open: false,
port: 3000,
tunnel: false,
watch: [
'src/layouts/**/*.*',
'src/partials/**/*.*',
'src/components/**/*.*',
],
},
/*
|-----------------------------------------------------------------------------
| Markdown https://maizzle.com/docs/markdown/#config
|-----------------------------------------------------------------------------
|
| Configure options for Marked.js.
|
*/
markdown: {
baseUrl: null,
breaks: false,
gfm: true,
headerIds: false,
headerPrefix: '',
highlight: null,
langPrefix: 'language-',
mangle: true,
pendantic: false,
sanitize: false,
sanitizer: null,
silent: false,
smartLists: false,
smartypants: false,
tables: true,
xhtml: false
},
/*
|-----------------------------------------------------------------------------
| Build https://maizzle.com/docs/build-paths/
|-----------------------------------------------------------------------------
|
| Configure build source and destination paths.
|
*/
build: {
destination: {
path: 'build_local',
extension: 'html',
},
layout: 'src/layouts/default.njk',
templates: {
source: 'src/templates',
filetypes: 'html|njk|nunjucks',
},
tailwind: {
css: 'src/assets/css/main.css',
config: 'tailwind.config.js',
},
assets: {
source: 'src/assets/images',
destination: 'images',
},
},
}