domma-cms 1.66.8 → 1.66.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/admin/js/app.js +2 -2
- package/admin/js/templates/docs/usage-shortcodes-components.html +366 -0
- package/admin/js/templates/docs/usage-shortcodes-content.html +550 -0
- package/admin/js/templates/docs/usage-shortcodes-data.html +469 -0
- package/admin/js/templates/docs/usage-shortcodes-effects.html +880 -0
- package/admin/js/templates/docs/usage-shortcodes-layout.html +732 -0
- package/admin/js/templates/docs/usage-shortcodes.html +82 -0
- package/admin/js/templates/documentation.html +20 -0
- package/admin/js/views/doc-pages.js +1 -1
- package/admin/js/views/index.js +1 -1
- package/package.json +1 -1
- package/server/server.js +5 -0
- package/server/services/docs.js +5 -0
|
@@ -0,0 +1,732 @@
|
|
|
1
|
+
<div class="view-header">
|
|
2
|
+
<h1><span data-icon="layout"></span> Layout shortcodes</h1>
|
|
3
|
+
<a href="#/docs/usage/shortcodes" class="btn btn-ghost btn-sm"><span data-icon="arrow-left"></span> Shortcodes</a>
|
|
4
|
+
</div>
|
|
5
|
+
|
|
6
|
+
<div class="row">
|
|
7
|
+
<div class="col-12">
|
|
8
|
+
<div class="docs-body">
|
|
9
|
+
|
|
10
|
+
<p>These shortcodes arrange a page: columns, containers, backdrops, banners at the top and panels at the side. Each one has its own section below, with an example to copy and every attribute it takes.</p>
|
|
11
|
+
<p>In the page editor, everything here is under <strong>Insert</strong>, and a right-click on a tag you have already written opens its settings. Attribute values take single or double quotes; a word on its own (<code>hover</code>, <code>reveal</code>) is a switch.</p>
|
|
12
|
+
<h3 id="sc-background"><code>background</code> - a backdrop for a page or section</h3>
|
|
13
|
+
<p>Sets the backdrop of a page, or of one section of it.</p>
|
|
14
|
+
<p>Written on its own, it colours the whole page:</p>
|
|
15
|
+
<pre><code>[background preset="lavender-haze" /]
|
|
16
|
+
[background color="#f6f4fc" /]
|
|
17
|
+
</code></pre>
|
|
18
|
+
<p>Written as a pair, it colours only what is between the tags:</p>
|
|
19
|
+
<pre><code>[background preset="ocean"]
|
|
20
|
+
[grid cols="2" gap="3"]
|
|
21
|
+
[card title="Consulting"]First service.[/card]
|
|
22
|
+
[card title="Development"]Second service.[/card]
|
|
23
|
+
[/grid]
|
|
24
|
+
[/background]
|
|
25
|
+
</code></pre>
|
|
26
|
+
<table class="table table-sm">
|
|
27
|
+
<thead>
|
|
28
|
+
<tr>
|
|
29
|
+
<th>Attribute</th>
|
|
30
|
+
<th>What it does</th>
|
|
31
|
+
</tr>
|
|
32
|
+
</thead>
|
|
33
|
+
<tbody><tr>
|
|
34
|
+
<td><code>preset</code></td>
|
|
35
|
+
<td>A ready-made backdrop: <code>lavender-haze</code>, <code>aurora</code>, <code>peach-mist</code>, <code>ocean</code>, <code>sunset</code>, <code>spotlight</code></td>
|
|
36
|
+
</tr>
|
|
37
|
+
<tr>
|
|
38
|
+
<td><code>type</code></td>
|
|
39
|
+
<td><code>solid</code>, <code>linear</code>, <code>radial</code> or <code>glow</code></td>
|
|
40
|
+
</tr>
|
|
41
|
+
<tr>
|
|
42
|
+
<td><code>color</code></td>
|
|
43
|
+
<td>One colour: a hex value, or a theme name (<code>background</code>, <code>surface</code>, <code>primary</code>, <code>secondary</code>, <code>success</code>, <code>info</code>, <code>warning</code>, <code>danger</code>)</td>
|
|
44
|
+
</tr>
|
|
45
|
+
<tr>
|
|
46
|
+
<td><code>colors</code></td>
|
|
47
|
+
<td>Two to four colours, comma separated, for a gradient. A position can follow each: <code>#41345b 0%,#a8d4e3 65%,#fff 100%</code></td>
|
|
48
|
+
</tr>
|
|
49
|
+
<tr>
|
|
50
|
+
<td><code>angle</code></td>
|
|
51
|
+
<td>Direction of a linear gradient, 0-360 degrees</td>
|
|
52
|
+
</tr>
|
|
53
|
+
<tr>
|
|
54
|
+
<td><code>x</code>, <code>y</code></td>
|
|
55
|
+
<td>Where a radial gradient or the first glow sits, 0-100 percent</td>
|
|
56
|
+
</tr>
|
|
57
|
+
<tr>
|
|
58
|
+
<td><code>spread</code></td>
|
|
59
|
+
<td>How far a radial gradient or glow reaches, 10-150 percent</td>
|
|
60
|
+
</tr>
|
|
61
|
+
<tr>
|
|
62
|
+
<td><code>strength</code></td>
|
|
63
|
+
<td>How strong a glow's colour is, 0-100 percent</td>
|
|
64
|
+
</tr>
|
|
65
|
+
</tbody></table>
|
|
66
|
+
<p>Good to know:</p>
|
|
67
|
+
<ul>
|
|
68
|
+
<li>A page background replaces the site's own (<strong>Content > Theme > Site background</strong>) on that page. Remove the tag and the site's comes back.</li>
|
|
69
|
+
<li>If a page has several, the last one counts.</li>
|
|
70
|
+
<li>A preset can be adjusted: <code>[background preset="lavender-haze" strength="60" /]</code>.</li>
|
|
71
|
+
<li>Backgrounds do not change text colours, so check the preview against your theme.</li>
|
|
72
|
+
<li>In the editor: <strong>Insert > Layout > Background</strong>, or right-click a background tag and choose <strong>Edit Background…</strong>. Selecting text first wraps a section around it.</li>
|
|
73
|
+
</ul>
|
|
74
|
+
<h3 id="sc-grid"><code>grid</code> - equal columns</h3>
|
|
75
|
+
<p>Columns of equal width. Put a <code>[col]</code> around each column's content.</p>
|
|
76
|
+
<pre><code>[grid cols="3" gap="3"]
|
|
77
|
+
[col]First column, with **Markdown**.[/col]
|
|
78
|
+
[col]Second column.[/col]
|
|
79
|
+
[col]Third column.[/col]
|
|
80
|
+
[/grid]
|
|
81
|
+
</code></pre>
|
|
82
|
+
<table class="table table-sm">
|
|
83
|
+
<thead>
|
|
84
|
+
<tr>
|
|
85
|
+
<th>Attribute</th>
|
|
86
|
+
<th>What it does</th>
|
|
87
|
+
</tr>
|
|
88
|
+
</thead>
|
|
89
|
+
<tbody><tr>
|
|
90
|
+
<td><code>cols</code></td>
|
|
91
|
+
<td>How many columns. On a phone the grid stacks into one column, then widens on larger screens</td>
|
|
92
|
+
</tr>
|
|
93
|
+
<tr>
|
|
94
|
+
<td><code>gap</code></td>
|
|
95
|
+
<td>The space between columns, 1 (tight) to 6 (wide)</td>
|
|
96
|
+
</tr>
|
|
97
|
+
<tr>
|
|
98
|
+
<td><code>responsive</code></td>
|
|
99
|
+
<td><code>false</code> keeps exactly <code>cols</code> columns on every screen, phones included</td>
|
|
100
|
+
</tr>
|
|
101
|
+
<tr>
|
|
102
|
+
<td><code>fullwidth</code></td>
|
|
103
|
+
<td><code>true</code> lets the grid run wider than the text column</td>
|
|
104
|
+
</tr>
|
|
105
|
+
<tr>
|
|
106
|
+
<td><code>vertical-align</code></td>
|
|
107
|
+
<td>How columns of different heights line up: <code>top</code>, <code>middle</code> or <code>bottom</code></td>
|
|
108
|
+
</tr>
|
|
109
|
+
<tr>
|
|
110
|
+
<td><code>class</code>, <code>id</code></td>
|
|
111
|
+
<td>Your own CSS class or id on the grid</td>
|
|
112
|
+
</tr>
|
|
113
|
+
</tbody></table>
|
|
114
|
+
<p>Good to know:</p>
|
|
115
|
+
<ul>
|
|
116
|
+
<li>Grids nest: a grid can sit inside a column of another grid, and cards can go inside either.</li>
|
|
117
|
+
<li>Close tags in the reverse of the order you opened them.</li>
|
|
118
|
+
</ul>
|
|
119
|
+
<h3 id="sc-row"><code>row</code> - columns that share the width</h3>
|
|
120
|
+
<p>Like a grid, but you do not count the columns: each <code>[col]</code> inside shares the width equally. A row can also bring its columns into view one after another as the visitor scrolls.</p>
|
|
121
|
+
<pre><code>[row gap="2"]
|
|
122
|
+
[col]Column A[/col]
|
|
123
|
+
[col]Column B[/col]
|
|
124
|
+
[col]Column C[/col]
|
|
125
|
+
[/row]
|
|
126
|
+
|
|
127
|
+
[row gap="4" reveal reveal-animation="slide-up" reveal-stagger="60"]
|
|
128
|
+
[col]First to appear[/col]
|
|
129
|
+
[col]Second to appear[/col]
|
|
130
|
+
[col]Third to appear[/col]
|
|
131
|
+
[/row]
|
|
132
|
+
</code></pre>
|
|
133
|
+
<table class="table table-sm">
|
|
134
|
+
<thead>
|
|
135
|
+
<tr>
|
|
136
|
+
<th>Attribute</th>
|
|
137
|
+
<th>What it does</th>
|
|
138
|
+
</tr>
|
|
139
|
+
</thead>
|
|
140
|
+
<tbody><tr>
|
|
141
|
+
<td><code>gap</code></td>
|
|
142
|
+
<td>The space between columns, 1 to 6</td>
|
|
143
|
+
</tr>
|
|
144
|
+
<tr>
|
|
145
|
+
<td><code>reveal</code></td>
|
|
146
|
+
<td>Switch: the columns animate in when the row scrolls into view</td>
|
|
147
|
+
</tr>
|
|
148
|
+
<tr>
|
|
149
|
+
<td><code>reveal-animation</code></td>
|
|
150
|
+
<td><code>slide-up</code>, <code>slide-down</code>, <code>slide-left</code>, <code>slide-right</code>, <code>fade</code>, <code>zoom</code>, <code>flip</code>, <code>swoosh</code> (rise out of a soft blur) or <code>swoosh-sides</code> (first from the left, last from the right)</td>
|
|
151
|
+
</tr>
|
|
152
|
+
<tr>
|
|
153
|
+
<td><code>reveal-mode</code></td>
|
|
154
|
+
<td><code>stagger</code> (the default, one after another) or <code>sequence</code></td>
|
|
155
|
+
</tr>
|
|
156
|
+
<tr>
|
|
157
|
+
<td><code>reveal-duration</code></td>
|
|
158
|
+
<td>How long each column's animation takes, in milliseconds (default 400)</td>
|
|
159
|
+
</tr>
|
|
160
|
+
<tr>
|
|
161
|
+
<td><code>reveal-stagger</code></td>
|
|
162
|
+
<td>The wait between one column and the next, in milliseconds (default 60)</td>
|
|
163
|
+
</tr>
|
|
164
|
+
<tr>
|
|
165
|
+
<td><code>reveal-delay</code></td>
|
|
166
|
+
<td>A wait before the first column, in milliseconds</td>
|
|
167
|
+
</tr>
|
|
168
|
+
<tr>
|
|
169
|
+
<td><code>reveal-direction</code></td>
|
|
170
|
+
<td><code>ltr</code> (left to right, the default) or <code>rtl</code></td>
|
|
171
|
+
</tr>
|
|
172
|
+
<tr>
|
|
173
|
+
<td><code>reveal-replay</code></td>
|
|
174
|
+
<td>Switch: play again each time the row comes back into view</td>
|
|
175
|
+
</tr>
|
|
176
|
+
<tr>
|
|
177
|
+
<td><code>tilt</code></td>
|
|
178
|
+
<td>Switch: each column leans toward the mouse pointer</td>
|
|
179
|
+
</tr>
|
|
180
|
+
<tr>
|
|
181
|
+
<td><code>vertical-align</code></td>
|
|
182
|
+
<td><code>top</code>, <code>middle</code> or <code>bottom</code></td>
|
|
183
|
+
</tr>
|
|
184
|
+
<tr>
|
|
185
|
+
<td><code>class</code>, <code>id</code></td>
|
|
186
|
+
<td>Your own CSS class or id on the row</td>
|
|
187
|
+
</tr>
|
|
188
|
+
</tbody></table>
|
|
189
|
+
<p>Animations are skipped for visitors whose device asks for reduced motion.</p>
|
|
190
|
+
<h3 id="sc-col"><code>col</code> - one column of a grid or row</h3>
|
|
191
|
+
<p>One column of a <code>[grid]</code> or <code>[row]</code>. It only works inside one of those.</p>
|
|
192
|
+
<pre><code>[grid cols="3" gap="2"]
|
|
193
|
+
[col span="2"]A wide column, two of the three.[/col]
|
|
194
|
+
[col centre]A narrow one, centred.[/col]
|
|
195
|
+
[/grid]
|
|
196
|
+
</code></pre>
|
|
197
|
+
<table class="table table-sm">
|
|
198
|
+
<thead>
|
|
199
|
+
<tr>
|
|
200
|
+
<th>Attribute</th>
|
|
201
|
+
<th>What it does</th>
|
|
202
|
+
</tr>
|
|
203
|
+
</thead>
|
|
204
|
+
<tbody><tr>
|
|
205
|
+
<td><code>span</code></td>
|
|
206
|
+
<td>How many grid columns this one takes up</td>
|
|
207
|
+
</tr>
|
|
208
|
+
<tr>
|
|
209
|
+
<td><code>align</code></td>
|
|
210
|
+
<td><code>left</code>, <code>center</code> (or <code>centre</code>) or <code>right</code></td>
|
|
211
|
+
</tr>
|
|
212
|
+
<tr>
|
|
213
|
+
<td><code>left</code>, <code>center</code>, <code>centre</code>, <code>right</code></td>
|
|
214
|
+
<td>The same as <code>align</code>, as a single word: <code>[col centre]</code></td>
|
|
215
|
+
</tr>
|
|
216
|
+
<tr>
|
|
217
|
+
<td><code>vertical-align</code></td>
|
|
218
|
+
<td>Where the content sits in a tall column: <code>top</code>, <code>middle</code> or <code>bottom</code></td>
|
|
219
|
+
</tr>
|
|
220
|
+
<tr>
|
|
221
|
+
<td><code>id</code></td>
|
|
222
|
+
<td>Your own id on the column</td>
|
|
223
|
+
</tr>
|
|
224
|
+
</tbody></table>
|
|
225
|
+
<p>A column also takes the effects <code>reveal</code>, <code>breathe</code> and <code>ripple</code> as switches - see <a href="#/docs/usage/shortcodes-effects">Effects</a>.</p>
|
|
226
|
+
<h3 id="sc-center"><code>center</code> - centred content</h3>
|
|
227
|
+
<p>Centres whatever is inside it.</p>
|
|
228
|
+
<pre><code>[center]
|
|
229
|
+
## Opening hours
|
|
230
|
+
Monday to Friday, 9 to 5.
|
|
231
|
+
[/center]
|
|
232
|
+
</code></pre>
|
|
233
|
+
<table class="table table-sm">
|
|
234
|
+
<thead>
|
|
235
|
+
<tr>
|
|
236
|
+
<th>Attribute</th>
|
|
237
|
+
<th>What it does</th>
|
|
238
|
+
</tr>
|
|
239
|
+
</thead>
|
|
240
|
+
<tbody><tr>
|
|
241
|
+
<td><code>class</code></td>
|
|
242
|
+
<td>Your own CSS class on the wrapper</td>
|
|
243
|
+
</tr>
|
|
244
|
+
</tbody></table>
|
|
245
|
+
<p>The tag is spelt <code>center</code>.</p>
|
|
246
|
+
<h3 id="sc-spacer"><code>spacer</code> - a gap</h3>
|
|
247
|
+
<p>A gap between two parts of a page.</p>
|
|
248
|
+
<pre><code>[spacer /]
|
|
249
|
+
[spacer size="48" /]
|
|
250
|
+
</code></pre>
|
|
251
|
+
<table class="table table-sm">
|
|
252
|
+
<thead>
|
|
253
|
+
<tr>
|
|
254
|
+
<th>Attribute</th>
|
|
255
|
+
<th>What it does</th>
|
|
256
|
+
</tr>
|
|
257
|
+
</thead>
|
|
258
|
+
<tbody><tr>
|
|
259
|
+
<td><code>size</code></td>
|
|
260
|
+
<td>The height of the gap in pixels. Without it, the site's standard spacer size is used</td>
|
|
261
|
+
</tr>
|
|
262
|
+
<tr>
|
|
263
|
+
<td><code>class</code></td>
|
|
264
|
+
<td>Your own CSS class</td>
|
|
265
|
+
</tr>
|
|
266
|
+
</tbody></table>
|
|
267
|
+
<h3 id="sc-card"><code>card</code> - a panel with a title</h3>
|
|
268
|
+
<p>A bordered panel with an optional title, icon, picture and footer. It is the most used container on most sites.</p>
|
|
269
|
+
<pre><code>[card title="Getting started" icon="rocket"]
|
|
270
|
+
Follow these steps to set up your site.
|
|
271
|
+
[/card]
|
|
272
|
+
|
|
273
|
+
[card title="Why us" layout="icon-top" icon="star" variant="glass"]
|
|
274
|
+
Fast, file-based and friendly.
|
|
275
|
+
[/card]
|
|
276
|
+
|
|
277
|
+
[card title="Our studio" image="/media/studio.jpg" image-alt="The studio floor" overlay="Open every Saturday"]
|
|
278
|
+
Drop in for a tour.
|
|
279
|
+
[/card]
|
|
280
|
+
</code></pre>
|
|
281
|
+
<table class="table table-sm">
|
|
282
|
+
<thead>
|
|
283
|
+
<tr>
|
|
284
|
+
<th>Attribute</th>
|
|
285
|
+
<th>What it does</th>
|
|
286
|
+
</tr>
|
|
287
|
+
</thead>
|
|
288
|
+
<tbody><tr>
|
|
289
|
+
<td><code>title</code>, <code>subtitle</code></td>
|
|
290
|
+
<td>The heading and the line under it. Leave both out for a card with a body only</td>
|
|
291
|
+
</tr>
|
|
292
|
+
<tr>
|
|
293
|
+
<td><code>icon</code></td>
|
|
294
|
+
<td>An icon beside the title</td>
|
|
295
|
+
</tr>
|
|
296
|
+
<tr>
|
|
297
|
+
<td><code>icon-layout</code></td>
|
|
298
|
+
<td><code>inline</code> (beside the title, the default) or <code>stacked</code> (above it)</td>
|
|
299
|
+
</tr>
|
|
300
|
+
<tr>
|
|
301
|
+
<td><code>icon-size</code></td>
|
|
302
|
+
<td><code>xs</code>, <code>sm</code>, <code>md</code>, <code>lg</code>, <code>xl</code>, <code>2xl</code>, or a size such as <code>48</code> or <code>3rem</code></td>
|
|
303
|
+
</tr>
|
|
304
|
+
<tr>
|
|
305
|
+
<td><code>icon-align</code></td>
|
|
306
|
+
<td><code>left</code>, <code>center</code> or <code>right</code></td>
|
|
307
|
+
</tr>
|
|
308
|
+
<tr>
|
|
309
|
+
<td><code>footer</code></td>
|
|
310
|
+
<td>Text for a strip at the bottom</td>
|
|
311
|
+
</tr>
|
|
312
|
+
<tr>
|
|
313
|
+
<td><code>layout</code></td>
|
|
314
|
+
<td>One of 33 ready-made designs, such as <code>icon-top</code>, <code>image-top</code>, <code>pricing</code>, <code>quote-testimonial</code>, <code>stat-metric</code></td>
|
|
315
|
+
</tr>
|
|
316
|
+
<tr>
|
|
317
|
+
<td><code>variant</code></td>
|
|
318
|
+
<td>The look: <code>clean</code>, <code>gradient</code>, <code>glass</code>, <code>accent</code>, <code>dark</code> or <code>glow</code></td>
|
|
319
|
+
</tr>
|
|
320
|
+
<tr>
|
|
321
|
+
<td><code>gradient</code></td>
|
|
322
|
+
<td>The gradient to use with <code>variant="gradient"</code></td>
|
|
323
|
+
</tr>
|
|
324
|
+
<tr>
|
|
325
|
+
<td><code>image</code></td>
|
|
326
|
+
<td>A picture: a band across the top, or behind the body</td>
|
|
327
|
+
</tr>
|
|
328
|
+
<tr>
|
|
329
|
+
<td><code>image-position</code></td>
|
|
330
|
+
<td><code>header</code> (a band above the title, the default) or <code>body</code> (behind the text)</td>
|
|
331
|
+
</tr>
|
|
332
|
+
<tr>
|
|
333
|
+
<td><code>image-height</code></td>
|
|
334
|
+
<td>The band's height, such as <code>240</code> or <code>40vh</code></td>
|
|
335
|
+
</tr>
|
|
336
|
+
<tr>
|
|
337
|
+
<td><code>image-alt</code></td>
|
|
338
|
+
<td>What the picture shows, for screen readers</td>
|
|
339
|
+
</tr>
|
|
340
|
+
<tr>
|
|
341
|
+
<td><code>overlay</code></td>
|
|
342
|
+
<td>Words written over the picture</td>
|
|
343
|
+
</tr>
|
|
344
|
+
<tr>
|
|
345
|
+
<td><code>overlay-position</code></td>
|
|
346
|
+
<td><code>bottom</code> (default), <code>center</code> or <code>top</code></td>
|
|
347
|
+
</tr>
|
|
348
|
+
<tr>
|
|
349
|
+
<td><code>collapsible</code></td>
|
|
350
|
+
<td><code>true</code>: clicking the title opens and closes the body</td>
|
|
351
|
+
</tr>
|
|
352
|
+
<tr>
|
|
353
|
+
<td><code>hover</code></td>
|
|
354
|
+
<td>Switch: highlight on hover. <code>hover="off"</code> stops the card lifting</td>
|
|
355
|
+
</tr>
|
|
356
|
+
<tr>
|
|
357
|
+
<td><code>font</code></td>
|
|
358
|
+
<td><code>serif</code> or <code>mono</code></td>
|
|
359
|
+
</tr>
|
|
360
|
+
<tr>
|
|
361
|
+
<td><code>font-size</code></td>
|
|
362
|
+
<td><code>sm</code>, <code>lg</code> or <code>xl</code></td>
|
|
363
|
+
</tr>
|
|
364
|
+
<tr>
|
|
365
|
+
<td><code>text-align</code></td>
|
|
366
|
+
<td><code>center</code> or <code>right</code></td>
|
|
367
|
+
</tr>
|
|
368
|
+
<tr>
|
|
369
|
+
<td><code>padding</code></td>
|
|
370
|
+
<td><code>compact</code> or <code>spacious</code></td>
|
|
371
|
+
</tr>
|
|
372
|
+
<tr>
|
|
373
|
+
<td><code>shadow</code></td>
|
|
374
|
+
<td><code>none</code>, <code>md</code> or <code>lg</code></td>
|
|
375
|
+
</tr>
|
|
376
|
+
<tr>
|
|
377
|
+
<td><code>rounded</code></td>
|
|
378
|
+
<td>Corners: <code>none</code>, <code>xs</code>, <code>sm</code>, <code>lg</code> or <code>full</code></td>
|
|
379
|
+
</tr>
|
|
380
|
+
<tr>
|
|
381
|
+
<td><code>borderless</code></td>
|
|
382
|
+
<td>Switch: no border</td>
|
|
383
|
+
</tr>
|
|
384
|
+
<tr>
|
|
385
|
+
<td><code>span</code></td>
|
|
386
|
+
<td>In a grid: how many columns the card takes, 2 to 6 or <code>full</code></td>
|
|
387
|
+
</tr>
|
|
388
|
+
<tr>
|
|
389
|
+
<td><code>vertical-align</code></td>
|
|
390
|
+
<td>Where the content sits in a tall card: <code>top</code>, <code>middle</code> or <code>bottom</code></td>
|
|
391
|
+
</tr>
|
|
392
|
+
<tr>
|
|
393
|
+
<td><code>class</code>, <code>id</code></td>
|
|
394
|
+
<td>Your own CSS class or id</td>
|
|
395
|
+
</tr>
|
|
396
|
+
</tbody></table>
|
|
397
|
+
<p>Inside a card you can write three more tags when plain text is not enough:</p>
|
|
398
|
+
<pre><code>[card]
|
|
399
|
+
[header]
|
|
400
|
+
### A title with **bold** and [a link](/about)
|
|
401
|
+
[/header]
|
|
402
|
+
|
|
403
|
+
The body, as usual.
|
|
404
|
+
|
|
405
|
+
[footer]
|
|
406
|
+
[Read more](/about)
|
|
407
|
+
[/footer]
|
|
408
|
+
[/card]
|
|
409
|
+
</code></pre>
|
|
410
|
+
<ul>
|
|
411
|
+
<li><code>[header]</code> and <code>[footer]</code> take Markdown, and win over the <code>title</code> and <code>footer</code> attributes.</li>
|
|
412
|
+
<li><code>[overlay]</code> takes Markdown for the words over a picture, and wins over the <code>overlay</code> attribute.</li>
|
|
413
|
+
</ul>
|
|
414
|
+
<p>Good to know:</p>
|
|
415
|
+
<ul>
|
|
416
|
+
<li>The full list of layouts, variants and gradients, with pictures, is in <a href="#/docs/usage/shortcodes">Shortcodes</a> under Cards. The editor's Card builder offers all of them.</li>
|
|
417
|
+
<li>A card takes the effects <code>reveal</code>, <code>breathe</code>, <code>pulse</code>, <code>shake</code>, <code>twinkle</code> and <code>ripple</code> as switches: <code>[card title="Why us" reveal reveal-animation="zoom"]</code>.</li>
|
|
418
|
+
<li>Cards can go inside grids, boxes, slideovers and other cards.</li>
|
|
419
|
+
</ul>
|
|
420
|
+
<h3 id="sc-box"><code>box</code> - a plain container</h3>
|
|
421
|
+
<p>A card with no header: a plain container around anything. It starts with no shadow and nearly square corners.</p>
|
|
422
|
+
<pre><code>[box]
|
|
423
|
+
Anything here: text, a button, a grid or a card.
|
|
424
|
+
[/box]
|
|
425
|
+
|
|
426
|
+
[box color="warning"]
|
|
427
|
+
**Heads up:** the office is closed on Friday.
|
|
428
|
+
[/box]
|
|
429
|
+
|
|
430
|
+
[box color="#0f766e" rounded="lg" shadow="md"]
|
|
431
|
+
Our own brand teal, whatever the theme.
|
|
432
|
+
[/box]
|
|
433
|
+
</code></pre>
|
|
434
|
+
<table class="table table-sm">
|
|
435
|
+
<thead>
|
|
436
|
+
<tr>
|
|
437
|
+
<th>Attribute</th>
|
|
438
|
+
<th>What it does</th>
|
|
439
|
+
</tr>
|
|
440
|
+
</thead>
|
|
441
|
+
<tbody><tr>
|
|
442
|
+
<td><code>color</code> (or <code>colour</code>)</td>
|
|
443
|
+
<td>A theme colour (<code>primary</code>, <code>secondary</code>, <code>success</code>, <code>info</code>, <code>warning</code>, <code>danger</code>) or a hex colour</td>
|
|
444
|
+
</tr>
|
|
445
|
+
<tr>
|
|
446
|
+
<td><code>variant</code></td>
|
|
447
|
+
<td>As on a card: <code>clean</code>, <code>glass</code>, <code>accent</code>, <code>dark</code>, <code>glow</code>, <code>gradient</code></td>
|
|
448
|
+
</tr>
|
|
449
|
+
<tr>
|
|
450
|
+
<td><code>shadow</code></td>
|
|
451
|
+
<td><code>none</code> (default), <code>md</code> or <code>lg</code></td>
|
|
452
|
+
</tr>
|
|
453
|
+
<tr>
|
|
454
|
+
<td><code>rounded</code></td>
|
|
455
|
+
<td><code>xs</code> (default), <code>none</code>, <code>sm</code>, <code>lg</code> or <code>full</code></td>
|
|
456
|
+
</tr>
|
|
457
|
+
<tr>
|
|
458
|
+
<td><code>padding</code></td>
|
|
459
|
+
<td><code>compact</code> or <code>spacious</code></td>
|
|
460
|
+
</tr>
|
|
461
|
+
<tr>
|
|
462
|
+
<td><code>borderless</code></td>
|
|
463
|
+
<td>Switch: no border</td>
|
|
464
|
+
</tr>
|
|
465
|
+
<tr>
|
|
466
|
+
<td><code>hover</code></td>
|
|
467
|
+
<td><code>off</code> stops the box lifting under the pointer</td>
|
|
468
|
+
</tr>
|
|
469
|
+
<tr>
|
|
470
|
+
<td><code>footer</code></td>
|
|
471
|
+
<td>Text for a strip at the bottom</td>
|
|
472
|
+
</tr>
|
|
473
|
+
<tr>
|
|
474
|
+
<td><code>class</code>, <code>id</code></td>
|
|
475
|
+
<td>Your own CSS class or id</td>
|
|
476
|
+
</tr>
|
|
477
|
+
</tbody></table>
|
|
478
|
+
<p>Good to know:</p>
|
|
479
|
+
<ul>
|
|
480
|
+
<li>A plain box follows the theme, light or dark. A theme colour tints it; a hex colour is kept exactly, with black or white text chosen to stay readable.</li>
|
|
481
|
+
<li>A box never has a header: <code>title</code>, <code>icon</code>, <code>image</code> and <code>layout</code> are ignored.</li>
|
|
482
|
+
<li>A card can sit inside a box, and a box inside a card or another box.</li>
|
|
483
|
+
</ul>
|
|
484
|
+
<h3 id="sc-hero"><code>hero</code> - the banner at the top of a page</h3>
|
|
485
|
+
<p>The large banner at the top of a page: a title, a tagline, and a colour, gradient or picture behind them.</p>
|
|
486
|
+
<pre><code>[hero title="Welcome" tagline="Build something great" size="lg" variant="gradient-blue"]
|
|
487
|
+
Optional text underneath, with **Markdown**.
|
|
488
|
+
[/hero]
|
|
489
|
+
|
|
490
|
+
[hero title="Walk the hills" image="/media/hills.jpg" overlay="dark" size="xl" fullwidth="true"]
|
|
491
|
+
[button href="/walks" variant="primary"]Book a place[/button]
|
|
492
|
+
[/hero]
|
|
493
|
+
</code></pre>
|
|
494
|
+
<table class="table table-sm">
|
|
495
|
+
<thead>
|
|
496
|
+
<tr>
|
|
497
|
+
<th>Attribute</th>
|
|
498
|
+
<th>What it does</th>
|
|
499
|
+
</tr>
|
|
500
|
+
</thead>
|
|
501
|
+
<tbody><tr>
|
|
502
|
+
<td><code>title</code>, <code>tagline</code></td>
|
|
503
|
+
<td>The headline and the line under it</td>
|
|
504
|
+
</tr>
|
|
505
|
+
<tr>
|
|
506
|
+
<td><code>size</code></td>
|
|
507
|
+
<td><code>sm</code>, <code>lg</code>, <code>xl</code> (at least three quarters of the window) or <code>full</code></td>
|
|
508
|
+
</tr>
|
|
509
|
+
<tr>
|
|
510
|
+
<td><code>variant</code></td>
|
|
511
|
+
<td>A gradient behind the text, such as <code>gradient-blue</code>, <code>gradient-sunset</code>, <code>gradient-ocean</code>, <code>gradient-night</code>, or the plain <code>dark</code> and <code>primary</code>. Each theme also has its own pair, such as <code>gradient-forest-light</code> and <code>gradient-forest-dark</code></td>
|
|
512
|
+
</tr>
|
|
513
|
+
<tr>
|
|
514
|
+
<td><code>image</code></td>
|
|
515
|
+
<td>A picture behind the text</td>
|
|
516
|
+
</tr>
|
|
517
|
+
<tr>
|
|
518
|
+
<td><code>overlay</code></td>
|
|
519
|
+
<td>A shade over the picture so the words read: <code>light</code>, <code>dark</code>, <code>darker</code>, <code>gradient</code> or <code>gradient-reverse</code></td>
|
|
520
|
+
</tr>
|
|
521
|
+
<tr>
|
|
522
|
+
<td><code>bg-x</code>, <code>bg-y</code></td>
|
|
523
|
+
<td>Which part of the picture to keep in view: <code>left</code> / <code>center</code> / <code>right</code> and <code>top</code> / <code>center</code> / <code>bottom</code></td>
|
|
524
|
+
</tr>
|
|
525
|
+
<tr>
|
|
526
|
+
<td><code>bg-fit</code></td>
|
|
527
|
+
<td><code>cover</code> (fill the area, cropping; the default) or <code>contain</code> (show the whole picture)</td>
|
|
528
|
+
</tr>
|
|
529
|
+
<tr>
|
|
530
|
+
<td><code>color</code> (or <code>bg</code>)</td>
|
|
531
|
+
<td>A plain background colour</td>
|
|
532
|
+
</tr>
|
|
533
|
+
<tr>
|
|
534
|
+
<td><code>align</code></td>
|
|
535
|
+
<td><code>center</code> or <code>left</code></td>
|
|
536
|
+
</tr>
|
|
537
|
+
<tr>
|
|
538
|
+
<td><code>min-height</code></td>
|
|
539
|
+
<td>A least height, such as <code>60vh</code> or <code>400px</code></td>
|
|
540
|
+
</tr>
|
|
541
|
+
<tr>
|
|
542
|
+
<td><code>fullwidth</code></td>
|
|
543
|
+
<td><code>true</code>: the hero runs the full width of the window</td>
|
|
544
|
+
</tr>
|
|
545
|
+
<tr>
|
|
546
|
+
<td><code>twinkle</code></td>
|
|
547
|
+
<td>Switch: sparkling particles over the hero. <code>twinkle-count</code> and <code>twinkle-colour</code> adjust them</td>
|
|
548
|
+
</tr>
|
|
549
|
+
<tr>
|
|
550
|
+
<td><code>blobs</code></td>
|
|
551
|
+
<td>Switch: slowly drifting shapes behind the text. <code>blobs-type</code> picks the movement, as on <code>[ambient]</code></td>
|
|
552
|
+
</tr>
|
|
553
|
+
<tr>
|
|
554
|
+
<td><code>class</code>, <code>id</code></td>
|
|
555
|
+
<td>Your own CSS class or id</td>
|
|
556
|
+
</tr>
|
|
557
|
+
</tbody></table>
|
|
558
|
+
<p>A hero takes the effects <code>reveal</code>, <code>breathe</code>, <code>pulse</code>, <code>twinkle</code>, <code>ticker-tape</code>, <code>butterflies</code> and <code>strobe</code> as switches.</p>
|
|
559
|
+
<h3 id="sc-slideover"><code>slideover</code> - a panel that slides in</h3>
|
|
560
|
+
<p>A button that opens a panel sliding in from the side. What you write between the tags is what the panel shows.</p>
|
|
561
|
+
<pre><code>[slideover title="Delivery details" trigger="Read more" size="lg"]
|
|
562
|
+
We deliver **Monday to Saturday**.
|
|
563
|
+
|
|
564
|
+
[card title="Next day"]Order by 3pm.[/card]
|
|
565
|
+
[/slideover]
|
|
566
|
+
</code></pre>
|
|
567
|
+
<table class="table table-sm">
|
|
568
|
+
<thead>
|
|
569
|
+
<tr>
|
|
570
|
+
<th>Attribute</th>
|
|
571
|
+
<th>What it does</th>
|
|
572
|
+
</tr>
|
|
573
|
+
</thead>
|
|
574
|
+
<tbody><tr>
|
|
575
|
+
<td><code>title</code></td>
|
|
576
|
+
<td>The heading at the top of the panel</td>
|
|
577
|
+
</tr>
|
|
578
|
+
<tr>
|
|
579
|
+
<td><code>trigger</code></td>
|
|
580
|
+
<td>The words on the button (default "Open")</td>
|
|
581
|
+
</tr>
|
|
582
|
+
<tr>
|
|
583
|
+
<td><code>size</code></td>
|
|
584
|
+
<td>The panel's width: <code>sm</code>, <code>md</code> (default), <code>lg</code>, <code>xl</code> or <code>full</code></td>
|
|
585
|
+
</tr>
|
|
586
|
+
<tr>
|
|
587
|
+
<td><code>position</code></td>
|
|
588
|
+
<td><code>right</code> (default) or <code>left</code></td>
|
|
589
|
+
</tr>
|
|
590
|
+
</tbody></table>
|
|
591
|
+
<p>Cards, grids and most other shortcodes work inside a slideover. Do not put a slideover inside another slideover.</p>
|
|
592
|
+
<h3 id="sc-contents"><code>contents</code> - the "On this page" list</h3>
|
|
593
|
+
<p>Changes the "On this page" list for one page. That list is built from the page's headings by a layout with a sidebar; this tag draws nothing itself, it only changes the list's settings on the page it is written on.</p>
|
|
594
|
+
<pre><code>[contents numbered="true" headings="h2h3" title="On this page" /]
|
|
595
|
+
[contents side="right" collapsible="true" collapsed="true" /]
|
|
596
|
+
[contents hidden="true" /]
|
|
597
|
+
</code></pre>
|
|
598
|
+
<table class="table table-sm">
|
|
599
|
+
<thead>
|
|
600
|
+
<tr>
|
|
601
|
+
<th>Attribute</th>
|
|
602
|
+
<th>What it does</th>
|
|
603
|
+
</tr>
|
|
604
|
+
</thead>
|
|
605
|
+
<tbody><tr>
|
|
606
|
+
<td><code>title</code></td>
|
|
607
|
+
<td>The heading above the list</td>
|
|
608
|
+
</tr>
|
|
609
|
+
<tr>
|
|
610
|
+
<td><code>headings</code></td>
|
|
611
|
+
<td>Which headings to list: <code>auto</code>, <code>h2</code>, <code>h3</code> or <code>h2h3</code></td>
|
|
612
|
+
</tr>
|
|
613
|
+
<tr>
|
|
614
|
+
<td><code>exclude</code></td>
|
|
615
|
+
<td>Headings to leave out, comma separated</td>
|
|
616
|
+
</tr>
|
|
617
|
+
<tr>
|
|
618
|
+
<td><code>numbered</code></td>
|
|
619
|
+
<td><code>true</code> numbers the entries</td>
|
|
620
|
+
</tr>
|
|
621
|
+
<tr>
|
|
622
|
+
<td><code>side</code></td>
|
|
623
|
+
<td><code>left</code> or <code>right</code></td>
|
|
624
|
+
</tr>
|
|
625
|
+
<tr>
|
|
626
|
+
<td><code>width</code></td>
|
|
627
|
+
<td>The list's width, 160-480 pixels</td>
|
|
628
|
+
</tr>
|
|
629
|
+
<tr>
|
|
630
|
+
<td><code>sticky</code></td>
|
|
631
|
+
<td><code>true</code> keeps the list in view while the page scrolls</td>
|
|
632
|
+
</tr>
|
|
633
|
+
<tr>
|
|
634
|
+
<td><code>hidden</code></td>
|
|
635
|
+
<td><code>true</code> hides the list on this page</td>
|
|
636
|
+
</tr>
|
|
637
|
+
<tr>
|
|
638
|
+
<td><code>collapsible</code>, <code>collapsed</code></td>
|
|
639
|
+
<td>Let the visitor fold the list away; start it folded</td>
|
|
640
|
+
</tr>
|
|
641
|
+
<tr>
|
|
642
|
+
<td><code>autohide</code></td>
|
|
643
|
+
<td><code>true</code> tucks the list away until the pointer is near</td>
|
|
644
|
+
</tr>
|
|
645
|
+
<tr>
|
|
646
|
+
<td><code>floating</code></td>
|
|
647
|
+
<td><code>true</code> lifts the list into a floating panel; <code>float-anchor</code> places it (<code>TL</code>, <code>TR</code>, <code>BL</code>, <code>BR</code>, <code>L</code>, <code>R</code>) and <code>movable</code> lets the visitor drag it</td>
|
|
648
|
+
</tr>
|
|
649
|
+
<tr>
|
|
650
|
+
<td><code>scroll-spy</code></td>
|
|
651
|
+
<td><code>true</code> highlights the heading being read</td>
|
|
652
|
+
</tr>
|
|
653
|
+
<tr>
|
|
654
|
+
<td><code>hover</code>, <code>selected</code>, <code>accent</code></td>
|
|
655
|
+
<td>The highlight effects and colour, as on a menu</td>
|
|
656
|
+
</tr>
|
|
657
|
+
<tr>
|
|
658
|
+
<td><code>font</code>, <code>font-size</code>, <code>font-weight</code></td>
|
|
659
|
+
<td>The lettering</td>
|
|
660
|
+
</tr>
|
|
661
|
+
</tbody></table>
|
|
662
|
+
<p>The site-wide settings are under <strong>Layouts > Page contents settings</strong>. If a page has more than one <code>[contents]</code>, the first counts.</p>
|
|
663
|
+
<h3 id="sc-navbar"><code>navbar</code> - the navigation bar on one page</h3>
|
|
664
|
+
<p>Changes the site's navigation bar for one page - for example, hiding it on scroll or collapsing it on a landing page. It draws nothing itself.</p>
|
|
665
|
+
<pre><code>[navbar collapsed="true" /]
|
|
666
|
+
[navbar position="sticky" hide-on-scroll="true" /]
|
|
667
|
+
[navbar position="floating" float-anchor="TR" float-collapsible="true" /]
|
|
668
|
+
</code></pre>
|
|
669
|
+
<p>Every Behaviour setting of a menu can be written as an attribute. The ones used most:</p>
|
|
670
|
+
<table class="table table-sm">
|
|
671
|
+
<thead>
|
|
672
|
+
<tr>
|
|
673
|
+
<th>Attribute</th>
|
|
674
|
+
<th>What it does</th>
|
|
675
|
+
</tr>
|
|
676
|
+
</thead>
|
|
677
|
+
<tbody><tr>
|
|
678
|
+
<td><code>position</code></td>
|
|
679
|
+
<td>Where the bar sits, such as <code>sticky</code> or <code>floating</code></td>
|
|
680
|
+
</tr>
|
|
681
|
+
<tr>
|
|
682
|
+
<td><code>orientation</code></td>
|
|
683
|
+
<td><code>horizontal</code> or <code>vertical</code></td>
|
|
684
|
+
</tr>
|
|
685
|
+
<tr>
|
|
686
|
+
<td><code>side</code>, <code>align</code></td>
|
|
687
|
+
<td>Which side a vertical bar is on; how its items line up</td>
|
|
688
|
+
</tr>
|
|
689
|
+
<tr>
|
|
690
|
+
<td><code>collapsible</code>, <code>collapsed</code></td>
|
|
691
|
+
<td>Let the bar fold to a rail; start it folded</td>
|
|
692
|
+
</tr>
|
|
693
|
+
<tr>
|
|
694
|
+
<td><code>autohide</code></td>
|
|
695
|
+
<td><code>true</code> hides the bar until the pointer is near</td>
|
|
696
|
+
</tr>
|
|
697
|
+
<tr>
|
|
698
|
+
<td><code>hide-on-scroll</code></td>
|
|
699
|
+
<td><code>true</code> hides the bar while scrolling down</td>
|
|
700
|
+
</tr>
|
|
701
|
+
<tr>
|
|
702
|
+
<td><code>width</code></td>
|
|
703
|
+
<td>The width of a vertical bar</td>
|
|
704
|
+
</tr>
|
|
705
|
+
<tr>
|
|
706
|
+
<td><code>bar</code></td>
|
|
707
|
+
<td>The bar's look: <code>pill</code>, <code>segmented</code>, <code>underline</code>, <code>dock</code>, <code>neon</code>, <code>tabs</code>, <code>tiles</code>, <code>bubbles</code>, <code>brutalist</code>, <code>gradient</code></td>
|
|
708
|
+
</tr>
|
|
709
|
+
<tr>
|
|
710
|
+
<td><code>hover</code>, <code>selected</code>, <code>accent</code></td>
|
|
711
|
+
<td>The highlight effects and colour</td>
|
|
712
|
+
</tr>
|
|
713
|
+
<tr>
|
|
714
|
+
<td><code>font</code>, <code>font-size</code>, <code>font-weight</code>, <code>letter-spacing</code>, <code>icon-size</code></td>
|
|
715
|
+
<td>The lettering and icons</td>
|
|
716
|
+
</tr>
|
|
717
|
+
<tr>
|
|
718
|
+
<td><code>float-anchor</code>, <code>float-x</code>, <code>float-y</code>, <code>float-width</code>, <code>float-title</code>, <code>float-collapsible</code>, <code>float-movable</code></td>
|
|
719
|
+
<td>The floating panel's place, size, title and behaviour</td>
|
|
720
|
+
</tr>
|
|
721
|
+
</tbody></table>
|
|
722
|
+
<p>Good to know:</p>
|
|
723
|
+
<ul>
|
|
724
|
+
<li><code>true</code> and <code>false</code> switch a setting on or off, so a page can turn off something the menu turns on.</li>
|
|
725
|
+
<li>The first <code>[navbar]</code> on a page counts.</li>
|
|
726
|
+
<li>In the editor it is under <strong>Insert > Layout</strong>. Right-clicking the tag offers the common changes in one click.</li>
|
|
727
|
+
<li>The menu's own settings are explained in <a href="#/docs/usage/navigation">Navigation</a>.</li>
|
|
728
|
+
</ul>
|
|
729
|
+
|
|
730
|
+
</div>
|
|
731
|
+
</div>
|
|
732
|
+
</div>
|