Skip to content

Commit dd25ff4

Browse files
committed
Documentation
1 parent c4e7856 commit dd25ff4

File tree

2 files changed

+24
-20
lines changed

2 files changed

+24
-20
lines changed

docs/schema/plugins/privacy.json

+21-17
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,23 @@
2121
"type": "boolean",
2222
"default": true
2323
},
24-
"cache": {
25-
"title": "Enable caching of downloads",
26-
"type": "boolean",
27-
"default": true
28-
},
29-
"cache_dir": {
30-
"title": "Cache directory",
31-
"type": "string",
32-
"default": ".cache/plugin/privacy"
24+
"concurrency": {
25+
"title": "Concurrency (number of CPUs)",
26+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.concurrency",
27+
"type": "number",
28+
"default": 1
3329
},
3430
"external_assets": {
3531
"title": "External assets",
3632
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets",
3733
"oneOf": [
3834
{
3935
"title": "Bundle external assets",
40-
"enum": [
41-
"bundle"
42-
]
36+
"enum": ["bundle"]
4337
},
4438
{
4539
"title": "Report external assets as warnings",
46-
"enum": [
47-
"report"
48-
]
40+
"enum": ["report"]
4941
}
5042
],
5143
"default": "bundle"
@@ -56,12 +48,24 @@
5648
"type": "string",
5749
"default": "assets/external"
5850
},
51+
"external_assets_include": {
52+
"title": "External assets to include",
53+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_include",
54+
"type": "array",
55+
"items": {
56+
"title": "External assets matching this pattern will be downloaded",
57+
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_include",
58+
"pattern": ".*"
59+
},
60+
"uniqueItems": true,
61+
"minItems": 1
62+
},
5963
"external_assets_exclude": {
60-
"title": "External assets to be excluded",
64+
"title": "External assets to exclude",
6165
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_exclude",
6266
"type": "array",
6367
"items": {
64-
"title": "External assets matching this pattern will not be bundled",
68+
"title": "External assets matching this pattern will not be downloaded",
6569
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.external_assets_exclude",
6670
"pattern": ".*"
6771
},

docs/setup/ensuring-data-privacy.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -336,13 +336,13 @@ The following configuration options are available for external links:
336336
[`external_links`](#+privacy.external_links){ #+privacy.external_links }
337337

338338
: :octicons-milestone-24: Default: `true` – This option specifies whether the
339-
plugin should automatically annotate external links. By default,
340-
[`rel="noopener"`][noopener] is added to all links with `target="_blank"`:
339+
plugin should parse and process external links. If you want to speed up
340+
local builds, you can use an [environment variable]:
341341

342342
``` yaml
343343
plugins:
344344
- privacy:
345-
external_links: true
345+
external_links: !ENV [CI, false]
346346
```
347347

348348
[`external_links_attr_map`](#+privacy.external_links_attr_map){ #+privacy.external_links_attr_map }

0 commit comments

Comments
 (0)