|
3 | 3 | "title": "Built-in optimize plugin", |
4 | 4 | "oneOf": [ |
5 | 5 | { |
6 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin", |
| 6 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/", |
7 | 7 | "enum": [ |
8 | 8 | "optimize" |
9 | 9 | ] |
|
12 | 12 | "type": "object", |
13 | 13 | "properties": { |
14 | 14 | "optimize": { |
15 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin", |
| 15 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/", |
16 | 16 | "type": "object", |
17 | 17 | "properties": { |
18 | 18 | "enabled": { |
19 | 19 | "title": "Enable plugin", |
20 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.enabled", |
| 20 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.enabled", |
21 | 21 | "type": "boolean", |
22 | 22 | "default": true |
23 | 23 | }, |
24 | 24 | "concurrency": { |
25 | 25 | "title": "Concurrency (number of CPUs)", |
26 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.concurrency", |
| 26 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.concurrency", |
27 | 27 | "type": "number" |
28 | 28 | }, |
29 | 29 | "cache": { |
30 | 30 | "title": "Enable caching", |
31 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.cache", |
| 31 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.cache", |
32 | 32 | "type": "boolean", |
33 | 33 | "default": true |
34 | 34 | }, |
35 | 35 | "cache_dir": { |
36 | 36 | "title": "Cache directory", |
37 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.cache_dir", |
| 37 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.cache_dir", |
38 | 38 | "type": "string", |
39 | | - "default": ".cache/plugins/social" |
| 39 | + "default": ".cache/plugins/optimize" |
40 | 40 | }, |
41 | 41 | "optimize_png": { |
42 | 42 | "title": "Optimization of PNGs", |
43 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png", |
| 43 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png", |
44 | 44 | "type": "boolean", |
45 | 45 | "default": true |
46 | 46 | }, |
47 | 47 | "optimize_png_speed": { |
48 | 48 | "title": "Speed/quality tradeoff [1,10]", |
49 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png_speed", |
| 49 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_speed", |
50 | 50 | "type": "number", |
51 | 51 | "default": 4 |
52 | 52 | }, |
53 | 53 | "optimize_png_strip": { |
54 | 54 | "title": "Strip unnecessary metadata from PNGs", |
55 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_png_strip", |
| 55 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_strip", |
56 | 56 | "type": "boolean", |
57 | 57 | "default": true |
58 | 58 | }, |
59 | 59 | "optimize_jpg": { |
60 | 60 | "title": "Optimization of JPGs", |
61 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg", |
| 61 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg", |
62 | 62 | "type": "boolean", |
63 | 63 | "default": true |
64 | 64 | }, |
65 | 65 | "optimize_jpg_quality": { |
66 | 66 | "title": "Speed/quality tradeoff for pngquant [0,10]", |
67 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg_quality", |
| 67 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_quality", |
68 | 68 | "type": "number", |
69 | 69 | "default": 60 |
70 | 70 | }, |
71 | 71 | "optimize_jpg_progressive": { |
72 | 72 | "title": "Progressive encoding (faster rendering)", |
73 | | - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#+optimize.optimize_jpg_progressive", |
| 73 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_progressive", |
74 | 74 | "type": "boolean", |
75 | 75 | "default": true |
76 | 76 | }, |
| 77 | + "optimize_include": { |
| 78 | + "title": "Files or folders to include", |
| 79 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_include", |
| 80 | + "type": "array", |
| 81 | + "items": { |
| 82 | + "title": "Files or folders matching this pattern will be included", |
| 83 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_include", |
| 84 | + "pattern": ".*" |
| 85 | + }, |
| 86 | + "uniqueItems": true, |
| 87 | + "minItems": 1 |
| 88 | + }, |
| 89 | + "optimize_exclude": { |
| 90 | + "title": "Files or folders to exclude", |
| 91 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude", |
| 92 | + "type": "array", |
| 93 | + "items": { |
| 94 | + "title": "Files or folders matching this pattern will be excluded", |
| 95 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude", |
| 96 | + "pattern": ".*" |
| 97 | + }, |
| 98 | + "uniqueItems": true, |
| 99 | + "minItems": 1 |
| 100 | + }, |
77 | 101 | "print_gain": { |
78 | 102 | "title": "Print optimization gain", |
| 103 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain", |
79 | 104 | "type": "boolean", |
80 | 105 | "default": true |
81 | 106 | }, |
82 | 107 | "print_gain_summary": { |
83 | 108 | "title": "Print optimization gain summary", |
| 109 | + "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain_summary", |
84 | 110 | "type": "boolean", |
85 | 111 | "default": true |
86 | 112 | } |
|
0 commit comments