|
| 1 | +# Schema for the iconify extension |
| 2 | + |
| 3 | +$schema: https://m.canouil.dev/quarto-wizard/assets/schema/v1/extension-schema.json |
| 4 | + |
| 5 | +options: |
| 6 | + set: |
| 7 | + type: string |
| 8 | + default: "octicon" |
| 9 | + description: "Default icon set to use when not specified in the shortcode (e.g., 'mdi', 'fa-solid')." |
| 10 | + size: |
| 11 | + type: string |
| 12 | + description: "Default icon size as a keyword or CSS value (e.g., 'large', '2x', '1.5em')." |
| 13 | + width: |
| 14 | + type: string |
| 15 | + description: "Default icon width." |
| 16 | + height: |
| 17 | + type: string |
| 18 | + description: "Default icon height." |
| 19 | + flip: |
| 20 | + type: string |
| 21 | + description: "Default flip transformation for icons." |
| 22 | + enum: |
| 23 | + - horizontal |
| 24 | + - vertical |
| 25 | + - horizontal,vertical |
| 26 | + rotate: |
| 27 | + type: string |
| 28 | + description: "Default rotation for icons (e.g., '90deg', '180deg', '1')." |
| 29 | + style: |
| 30 | + type: string |
| 31 | + description: "Default additional inline CSS styles applied to all icons." |
| 32 | + inline: |
| 33 | + type: boolean |
| 34 | + default: true |
| 35 | + description: "Whether to render icons inline by default." |
| 36 | + mode: |
| 37 | + type: string |
| 38 | + description: "Default rendering mode for icons." |
| 39 | + enum: |
| 40 | + - svg |
| 41 | + - style |
| 42 | + - bg |
| 43 | + - mask |
| 44 | + |
| 45 | +# Per-shortcode schemas. |
| 46 | +# Describes positional arguments and named attributes for {{< iconify >}} and {{< quarto >}}. |
| 47 | +shortcodes: |
| 48 | + iconify: |
| 49 | + description: "Renders an Iconify icon. Accepts 'set:icon' or 'set icon' syntax." |
| 50 | + arguments: |
| 51 | + - name: set-or-icon |
| 52 | + type: string |
| 53 | + required: true |
| 54 | + description: "Icon set name, or 'set:icon' combined format." |
| 55 | + - name: icon |
| 56 | + type: string |
| 57 | + description: "Icon name when the first argument is the set name." |
| 58 | + attributes: |
| 59 | + size: |
| 60 | + type: string |
| 61 | + description: "Icon size as a keyword or CSS value (e.g., 'large', '2x', '1.5em')." |
| 62 | + width: |
| 63 | + type: string |
| 64 | + description: "Icon width." |
| 65 | + height: |
| 66 | + type: string |
| 67 | + description: "Icon height." |
| 68 | + flip: |
| 69 | + type: string |
| 70 | + description: "Flip transformation for the icon." |
| 71 | + enum: |
| 72 | + - horizontal |
| 73 | + - vertical |
| 74 | + - horizontal,vertical |
| 75 | + rotate: |
| 76 | + type: string |
| 77 | + description: "Rotation for the icon (e.g., '90deg', '180deg', '1')." |
| 78 | + inline: |
| 79 | + type: string |
| 80 | + description: "Whether to render the icon inline." |
| 81 | + enum: |
| 82 | + - "true" |
| 83 | + - "false" |
| 84 | + mode: |
| 85 | + type: string |
| 86 | + description: "Rendering mode for the icon." |
| 87 | + enum: |
| 88 | + - svg |
| 89 | + - style |
| 90 | + - bg |
| 91 | + - mask |
| 92 | + style: |
| 93 | + type: string |
| 94 | + description: "Additional inline CSS styles for the icon." |
| 95 | + label: |
| 96 | + type: string |
| 97 | + description: "Accessible label for the icon (aria-label)." |
| 98 | + title: |
| 99 | + type: string |
| 100 | + description: "Title attribute for the icon tooltip." |
| 101 | + quarto: |
| 102 | + description: "Renders the Quarto icon with default blue styling from the simple-icons set." |
| 103 | + attributes: |
| 104 | + size: |
| 105 | + type: string |
| 106 | + description: "Icon size as a keyword or CSS value." |
| 107 | + width: |
| 108 | + type: string |
| 109 | + description: "Icon width." |
| 110 | + height: |
| 111 | + type: string |
| 112 | + description: "Icon height." |
| 113 | + flip: |
| 114 | + type: string |
| 115 | + description: "Flip transformation for the icon." |
| 116 | + enum: |
| 117 | + - horizontal |
| 118 | + - vertical |
| 119 | + - horizontal,vertical |
| 120 | + rotate: |
| 121 | + type: string |
| 122 | + description: "Rotation for the icon (e.g., '90deg', '180deg', '1')." |
| 123 | + inline: |
| 124 | + type: string |
| 125 | + description: "Whether to render the icon inline." |
| 126 | + enum: |
| 127 | + - "true" |
| 128 | + - "false" |
| 129 | + mode: |
| 130 | + type: string |
| 131 | + description: "Rendering mode for the icon." |
| 132 | + enum: |
| 133 | + - svg |
| 134 | + - style |
| 135 | + - bg |
| 136 | + - mask |
| 137 | + style: |
| 138 | + type: string |
| 139 | + description: "Additional inline CSS styles for the icon." |
| 140 | + label: |
| 141 | + type: string |
| 142 | + description: "Accessible label for the icon." |
| 143 | + title: |
| 144 | + type: string |
| 145 | + description: "Title attribute for the icon tooltip." |
0 commit comments