Skip to content

Commit 6248e6b

Browse files
committed
Documentation
1 parent d30fa86 commit 6248e6b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/setup/setting-up-social-cards.md

+17
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,22 @@ The following configuration options are available for debugging:
338338
[Debug mode enabled]: ../assets/screenshots/social-cards-debug.png
339339
[Debug mode disabled]: ../assets/screenshots/social-cards-variant.png
340340

341+
[`debug_on_build`](#+social.debug_on_build){ #+social.debug_on_build }
342+
343+
: [:octicons-tag-24: insiders-4.34.1][Insiders] · :octicons-milestone-24:
344+
Default: `false` – Whether debug mode should be automatically disabled
345+
[when building your site] with `mkdocs build`. It can be changed with:
346+
347+
``` yaml
348+
plugins:
349+
- social:
350+
debug_on_build: true
351+
```
352+
353+
This setting is just intended to be a safety net, so that when building
354+
your site social cards definitely won't contain the dot grid or layer
355+
outlines by accident.
356+
341357
[`debug_grid`](#+social.debug_grid){ #+social.debug_grid }
342358

343359
: [:octicons-tag-24: insiders-4.33.0][Insiders] · :octicons-milestone-24:
@@ -377,6 +393,7 @@ The following configuration options are available for debugging:
377393
```
378394

379395
[debug]: #+social.debug
396+
[when building your site]: ../creating-your-site.md#building-your-site
380397

381398
#### Caching
382399

0 commit comments

Comments
 (0)