|
| 1 | +--- |
| 2 | +page_id: a923c804-819a-4683-b284-001c285626bc |
| 3 | +tags: [remark] |
| 4 | +--- |
| 5 | + |
| 6 | +# Code as Attribute |
| 7 | + |
| 8 | +Dieses Remark-Plugin ermöglicht es, Codeblöcke als Attribute an spezifizierte MDX-Komponenten zu übergeben. Dies ist besonders nützlich, wenn Codeblöcke als MD-Codeblock formatiert werden sollen, aber der Code als Inhalt an eine Komponente übergeben werden muss. |
| 9 | + |
| 10 | +Wird bspw. eingesetzt für: |
| 11 | +- [SVG-Editor](../../../gallery/persistable-documents/svg-editor/index.mdx) |
| 12 | +- [Netpbm-Editor](../../../gallery/persistable-documents/netpbm-editor/index.mdx) |
| 13 | +- [HTML-Editor](../../../gallery/persistable-documents/html-editor/index.mdx) |
| 14 | + |
| 15 | +:::flex{minWidth=250px} |
| 16 | +#### Vorher |
| 17 | +````md |
| 18 | +# Remark Code as Attribute |
| 19 | + |
| 20 | +<HtmlEditor> |
| 21 | +```html name="index.html" |
| 22 | +<h1>Foo Bar</h1> |
| 23 | +``` |
| 24 | +</HtmlEditor> |
| 25 | +```` |
| 26 | +::br |
| 27 | +#### Nachher |
| 28 | +```md |
| 29 | +<HtmlEditor code="\n<h1>Foo Bar</h1>\n" /> |
| 30 | +``` |
| 31 | +::: |
| 32 | + |
| 33 | +## Optionen |
| 34 | + |
| 35 | +### `codeAttributesName` |
| 36 | + |
| 37 | +Wird `codeAttributesName` angegeben, so werden die Attribute `lang` und `meta` des Codeblocks zusätzlich als Objekt mit diesem Namen übergeben. |
| 38 | + |
| 39 | +```ts title="Komponenten-Konfiguration" |
| 40 | +{ |
| 41 | + name: 'HtmlIDE', |
| 42 | + // highlight-start |
| 43 | + attributeName: 'code', |
| 44 | + codeAttributesName: 'codeAttributes' |
| 45 | + // highlight-end |
| 46 | +} |
| 47 | +``` |
| 48 | + |
| 49 | +:::flex{minWidth=250px} |
| 50 | +#### Vorher |
| 51 | +````md |
| 52 | +# Remark Code as Attribute |
| 53 | + |
| 54 | +<TemplateCode> |
| 55 | +```html name=index.html |
| 56 | +<h1>Foo Bar</h1> |
| 57 | +``` |
| 58 | +</TemplateCode> |
| 59 | +```` |
| 60 | +::br |
| 61 | +#### Nachher |
| 62 | +```md |
| 63 | +<TemplateCode |
| 64 | + code="\n<h1>Foo Bar</h1>\n" |
| 65 | + lang="html" |
| 66 | + meta="name=index.html" |
| 67 | +/> |
| 68 | +``` |
| 69 | +::: |
| 70 | + |
| 71 | +### `processMultiple` |
| 72 | +Ist `processMultiple` gesetzt, so werden alle aufeinanderfolgenden Codeblöcke als Array von Objekten an die Komponente übergeben, wobei der CodeBlock im Feld `code` zu finden ist. Jedes Objekt enthält den Code und ggf. die Attribute `lang` und `meta`. |
| 73 | + |
| 74 | +```ts title="Komponenten-Konfiguration" |
| 75 | +{ |
| 76 | + name: 'HtmlIDE', |
| 77 | + // highlight-start |
| 78 | + attributeName: 'files', |
| 79 | + processMultiple: true |
| 80 | + // highlight-end |
| 81 | +} |
| 82 | +``` |
| 83 | + |
| 84 | +:::flex{minWidth=250px} |
| 85 | +#### Vorher |
| 86 | +````md |
| 87 | +# Remark Code as Attribute |
| 88 | + |
| 89 | +<HtmlIDE> |
| 90 | +```html name=foo.html |
| 91 | +<h1>Foo</h1> |
| 92 | +``` |
| 93 | +```html name=bar.html |
| 94 | +<h1>Bar</h1> |
| 95 | +``` |
| 96 | +</HtmlIDE> |
| 97 | +```` |
| 98 | +::br |
| 99 | +#### Nachher |
| 100 | +```mdx |
| 101 | +<HtmlIDE |
| 102 | + files={[ |
| 103 | + { code: "\n<h1>Foo</h1>\n", lang: "html", meta: "name=foo.html" }, |
| 104 | + { code: "\n<h1>Bar</h1>\n", lang: "html", meta: "name=bar.html" } |
| 105 | + ]} |
| 106 | +/> |
| 107 | +``` |
| 108 | +::: |
| 109 | + |
| 110 | + |
| 111 | +## Installation |
| 112 | + |
| 113 | +:::info[Code] |
| 114 | +- `src/plugins/remark-code-as-attribute` |
| 115 | +::: |
| 116 | + |
| 117 | +:::info[`docusaurus.config.ts`] |
| 118 | +```ts |
| 119 | +import codeAsAttributePlugin from './src/plugins/remark-code-as-attribute/plugin'; |
| 120 | + |
| 121 | +const REMARK_PLUGINS = [ |
| 122 | + /* ... */ |
| 123 | + [ |
| 124 | + [ |
| 125 | + codeAsAttributePlugin, |
| 126 | + { |
| 127 | + components: [ |
| 128 | + { |
| 129 | + name: 'HtmlEditor', // Name der React-Komponente |
| 130 | + attributeName: 'code' // der Code wird als Attribut `code` übergeben |
| 131 | + }, |
| 132 | + { |
| 133 | + name: 'HtmlIDE', |
| 134 | + attributeName: 'files', |
| 135 | + processMultiple: true // der Code wird als Array von MultiCode-Objekten übergeben |
| 136 | + }, |
| 137 | + { |
| 138 | + name: 'TemplateCode', |
| 139 | + attributeName: 'code', |
| 140 | + codeAttributesName: 'codeAttributes' // es werden zusätzlich `lang` und `meta` übergeben |
| 141 | + } |
| 142 | + /*...*/ |
| 143 | + ], |
| 144 | + } |
| 145 | + ] |
| 146 | + ] |
| 147 | +]; |
| 148 | +``` |
| 149 | +::: |
0 commit comments