Skip to content

Commit 48c9737

Browse files
committed
Update docs
- change hierarchy
1 parent 1223b78 commit 48c9737

File tree

21 files changed

+79
-92
lines changed

21 files changed

+79
-92
lines changed

docs/pages/docs/configuration/backgrounds.md renamed to docs/pages/configuration/backgrounds.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ Hintergrundbildern bedeutet dies, dass jede einzelne CSS-Klasse dem Anwender bek
2424
Der ThemeManager erweitert eine Option im Dateisystem, sodass Bilder als Hintergrundbild definiert werden können.
2525

2626
<figure markdown>
27-
![Bild als Hintergrund festlegen](../../../assets/configuration/background/file-set-as-background.png){loading=lazy}
27+
![Bild als Hintergrund festlegen](../../assets/configuration/background/file-set-as-background.png){loading=lazy}
2828
<figcaption>Über die Option kann ein Hintergrundbild festgelegt werden</figcaption>
2929
</figure>
3030

3131
Da das `CSS` für Hintergrundbilder erst generiert werden muss, stehen diese erst nach Kompilieren des Themes zur
3232
Verfügung.
3333

3434
<figure markdown>
35-
![Compiler preview](../../../assets/configuration/background/background-compiler.png){loading=lazy}
35+
![Compiler preview](../../assets/configuration/background/background-compiler.png){loading=lazy}
3636
<figcaption>Der Asset-Compiler listet alle verfügbaren Hintergründe auf</figcaption>
3737
</figure>
3838

@@ -50,7 +50,7 @@ stehen.
5050
Anwender können die Hintergrundbilder unter dem Reiter Background auswählen. Die Beschriftung der Hintergrundbilder
5151
im Backend folgt hierbei dem Schema `BG-[Dateiname]`.
5252

53-
![Hintergrund auswählen](../../../assets/configuration/background/style-manager-background-image.png){loading=lazy}
53+
![Hintergrund auswählen](../../assets/configuration/background/style-manager-background-image.png){loading=lazy}
5454

5555
### Wo kann ich Hintergrundbilder einstellen?
5656

@@ -82,7 +82,7 @@ Der StyleManager ermöglicht es, dass CSS-Klassen an ausgewählten Stellen in ei
8282
(Template-Variablen).
8383

8484
<figure markdown>
85-
![Global, Component und Element](../../../assets/configuration/background/global-component-element.png){loading=lazy}
85+
![Global, Component und Element](../../assets/configuration/background/global-component-element.png){loading=lazy}
8686
<figcaption>Hervorhebung der Gruppen anhand einer Bild-Text-Liste. Lila hebt lediglich das gesamte Element (Global) hervor</figcaption>
8787
</figure>
8888

@@ -113,14 +113,14 @@ Der StyleManager ermöglicht es, dass CSS-Klassen an ausgewählten Stellen in ei
113113
Die im StyleManager verfügbaren Hintergrund-Einstellungen können genutzt werden, um das Verhalten des festgelegten
114114
Hintergrunds zu beeinflussen.
115115

116-
![Einstellungen im StyleManager](../../../assets/configuration/background/background-settings.png){loading=lazy}
116+
![Einstellungen im StyleManager](../../assets/configuration/background/background-settings.png){loading=lazy}
117117

118118
Die nachfolgende Tabelle erklärt alle weiteren Optionen, wobei der Standardwert bereits der `Best-Practice` folgt.
119119

120120
| Einstellung | Standardwert | Beschreibung |
121121
|---------------------|----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
122122
| Color | - | Hiermit kann eine Hintergrundfarbe ausgewählt werden. Eine Kombination mit transparenten Hintergrundbildern ist möglich. |
123-
| Image | [none](https://developer.mozilla.org/en-US/docs/Web/CSS/background-image) | Dient der Auswahl des Hintergrundbildes. Über die Option `none` kann ein über den [Skin](../../guides/skin/introduction.md) gesetztes Hintergrundbild entfernt werden. |
123+
| Image | [none](https://developer.mozilla.org/en-US/docs/Web/CSS/background-image) | Dient der Auswahl des Hintergrundbildes. Über die Option `none` kann ein über den [Skin](../guides/skin/introduction.md) gesetztes Hintergrundbild entfernt werden. |
124124
| Attachment | [scroll](https://developer.mozilla.org/en-US/docs/Web/CSS/background-attachment) | Über diese Einstellung wird das Hintergrundbild in der Position im Browserfenster fixiert, sodass dieses beim Scrollen an der selben Stelle bleibt. |
125125
| Repeat | [no-repeat](https://developer.mozilla.org/en-US/docs/Web/CSS/background-repeat) | Background-Repeat kann genutzt werden, damit kleine Bilder auf einer großen Fläche wiederholt werden. Wirkt nicht, wenn etwas in `Size` eingestellt wurde. |
126126
| Size | [cover](https://developer.mozilla.org/en-US/docs/Web/CSS/background-size) | Diese Einstellung bestimmt die Größe des eingesetzten Hintergrundbildes.<br><br>Über `contain` wird das Bild so groß wie möglich innerhalb des Containers skaliert, ohne das Bild zu beschneiden oder zu dehnen. Wenn das Bild zu klein für den Container ist, wird das Bild gekachelt, wenn eine Einstellung in `Size` vorgenommen wurde.<br><br>Die Einstellung `auto` skaliert das Bild in der entsprechenden Richtung, sodass die Proportionen erhalten bleiben. |
@@ -172,12 +172,12 @@ wurde eine neue Funktion hinzugefügt, welche in diversen Einstellungen von Hint
172172
Werden eigene Hintergrundfarben im StyleManager ergänzt, wird ein Platzhalter angezeigt.
173173

174174
<figure markdown>
175-
![Farbvorschau aktivieren](../../../assets/configuration/background/color-preview-setting.png){loading=lazy}
175+
![Farbvorschau aktivieren](../../assets/configuration/background/color-preview-setting.png){loading=lazy}
176176
<figcaption>Aktivieren der Farbvorschau in den Benutzer-Einstellungen</figcaption>
177177
</figure>
178178

179179
<figure markdown>
180-
![Farbvorschau in Einstellungen](../../../assets/configuration/background/color-preview.png){loading=lazy}
180+
![Farbvorschau in Einstellungen](../../assets/configuration/background/color-preview.png){loading=lazy}
181181
<figcaption>Farbvorschau innerhalb der Hintergrundfarben</figcaption>
182182
</figure>
183183

docs/pages/docs/configuration/icon-set.md renamed to docs/pages/configuration/icon-set.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Bei der Verwendung von Icon-Fonts, die über Dienste wie IcoMoon oder Fontello e
88
stellt sich oft die Herausforderung, die zugehörigen CSS-Dateien einzubinden und die entsprechenden Klassen in Templates
99
oder CSS-Anpassungen für Komponenten zu integrieren.
1010

11-
![Icon in einer Button-Komponente](../../../assets/configuration/icons/component-icon.png){loading=lazy}
11+
![Icon in einer Button-Komponente](../../assets/configuration/icons/component-icon.png){loading=lazy}
1212

1313
Der Contao ThemeManager ermöglicht es Anwendern, ihr Icon-Set direkt in den Systemeinstellungen auszuwählen. Automatisch
1414
generiert der ThemeManager das benötigte CSS, und die festgelegten Optionen stehen systemweit im StyleManager zur
@@ -29,7 +29,7 @@ entpackt werden.
2929

3030
Im Download einer IcoMoon-Schriftart befinden sich die benötigten Dateien im Ordner `fonts`:
3131

32-
![IcoMoon Download mit Dateien](../../../assets/configuration/icons/font-files.png){loading=lazy}
32+
![IcoMoon Download mit Dateien](../../assets/configuration/icons/font-files.png){loading=lazy}
3333

3434
Folgende Dateien müssen in *einen Ordner* abgelegt werden:
3535

@@ -39,7 +39,7 @@ Folgende Dateien müssen in *einen Ordner* abgelegt werden:
3939
Um die Icon-Schriftart einzubinden, muss die `*.svg` unter `System` -> `Einstellungen` unter ThemeManager eingebunden
4040
werden.
4141

42-
![Icon-Set einstellen](../../../assets/configuration/icons/settings-icon-set.png){loading=lazy}
42+
![Icon-Set einstellen](../../assets/configuration/icons/settings-icon-set.png){loading=lazy}
4343

4444
!!! tip
4545

@@ -49,17 +49,17 @@ werden.
4949
Nach Kompilieren des Themes stehen die neuen Icons in den Komponenten bereit.
5050

5151
<figure markdown>
52-
![Asset Compiler Report](../../../assets/configuration/icons/maintenance-generated-icon-font.png){loading=lazy}
52+
![Asset Compiler Report](../../assets/configuration/icons/maintenance-generated-icon-font.png){loading=lazy}
5353
<figcaption>Asset-Compiler Report</figcaption>
5454
</figure>
5555

5656
<figure markdown>
57-
![Icons innerhalb der Link-Einstellungen](../../../assets/configuration/icons/stylemanager-icon-picker.png){loading=lazy}
57+
![Icons innerhalb der Link-Einstellungen](../../assets/configuration/icons/stylemanager-icon-picker.png){loading=lazy}
5858
<figcaption>Icons innerhalb der Link-Einstellungen</figcaption>
5959
</figure>
6060

6161
<figure markdown>
62-
![Icon-Auswahl im RockSolid Icon-Picker](../../../assets/configuration/icons/rocksolid-icon-picker.png){loading=lazy}
62+
![Icon-Auswahl im RockSolid Icon-Picker](../../assets/configuration/icons/rocksolid-icon-picker.png){loading=lazy}
6363
<figcaption>Icon-Auswahl im RockSolid Icon-Picker</figcaption>
6464
</figure>
6565

@@ -70,7 +70,7 @@ Nach Kompilieren des Themes stehen die neuen Icons in den Komponenten bereit.
7070

7171
### Hinweise und Fehlermeldungen
7272

73-
![Hinweise und Fehlermeldungen im Asset-Compiler](../../../assets/configuration/icons/maintenance-no-icon-font-woff-file.png){loading=lazy}
73+
![Hinweise und Fehlermeldungen im Asset-Compiler](../../assets/configuration/icons/maintenance-no-icon-font-woff-file.png){loading=lazy}
7474

7575
Folgende Hinweise und Fehlermeldungen können vom Asset-Compiler zurückgegeben werden:
7676

@@ -105,7 +105,7 @@ gezogen werden, um die Icons zu laden.
105105
eine Dokumentation auf [GitHub](https://github.com/fontello/fontello/wiki/Help).
106106

107107
<figure markdown>
108-
![Übersicht der IcoMoon-App](../../../assets/configuration/icons/icoMoon.png){loading=lazy}
108+
![Übersicht der IcoMoon-App](../../assets/configuration/icons/icoMoon.png){loading=lazy}
109109
<figcaption>Übersicht der IcoMoon-App</figcaption>
110110
</figure>
111111

docs/pages/docs/configuration/theme/components.md renamed to docs/pages/configuration/theme/components.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Bei Einstellung der Option `box-shadow` wird ein zusätzlicher Schatten/Schlagsc
123123

124124
Wenn für alle Box-Komponenten nur der Schlagschatten ohne Rahmen erwünscht ist, kann der `$boxed-border-width` auf `0`
125125
gestellt werden. Soll der Rahmen bei `box` weiterhin bestehen bleiben, kann eine Option über einen eigenen
126-
[Skin](../../../guides/skin/introduction.md) individuell erweitert werden.
126+
[Skin](../../guides/skin/introduction.md) individuell erweitert werden.
127127

128128
---
129129

@@ -176,7 +176,7 @@ Folgende Einstellungen können hierbei vorgenommen werden:
176176
werden, welche im TinyMCE-Editor erstellt wurden.
177177

178178
Es ist derzeit nicht möglich, dass Tabellenstyles über den StyleManager *aktiviert oder *deaktiviert* werden können.
179-
Ist dies nicht erwünscht, können Tabellen im eigenen [Skin](../../../guides/skin/introduction.md) angepasst werden.
179+
Ist dies nicht erwünscht, können Tabellen im eigenen [Skin](../../guides/skin/introduction.md) angepasst werden.
180180

181181
### Tabellenzelle
182182

@@ -252,7 +252,7 @@ Bestandteile einer Tabelle einstellen:
252252
Bis auf die Icon-Schriftart bezieht sich die nachfolgende Konfiguration auf das Aussehen der durch den ThemeManager
253253
bereitgestellten Inhaltselemente `Icon`, `Icon-Text` und `Icon-Text-Liste`.
254254

255-
![Icon-Einstellungen](../../../../assets/configuration/components/icon-settings-stylemanager.png){loading=lazy}
255+
![Icon-Einstellungen](../../../assets/configuration/components/icon-settings-stylemanager.png){loading=lazy}
256256

257257
### Icon-Schriftart
258258

@@ -266,7 +266,7 @@ Diese Einstellung überschreibt die Schriftart der Icons, die vom ThemeManager v
266266
Generierung und Bereitstellung von Icons nicht mehr.
267267

268268
Das Ändern der hier eingestellten Schriftart wird nur empfohlen, wenn das Feature nicht benötigt wird und die
269-
verwendeten Icons über einen eigenen [Skin](../../../guides/skin/introduction.md) festgelegt werden.
269+
verwendeten Icons über einen eigenen [Skin](../../guides/skin/introduction.md) festgelegt werden.
270270

271271
### Größe der Icons
272272

@@ -289,7 +289,7 @@ wird.
289289
`$icon-outlined-width`
290290

291291
Über die Optionen `Design` sowie `Shape` kann das Aussehen von Icons modifiziert werden.
292-
![Icon-Designs](../../../../assets/configuration/components/icons.png){loading=lazy}
292+
![Icon-Designs](../../../assets/configuration/components/icons.png){loading=lazy}
293293
Die Auswahl des Designs `Outline` in den zuvor beschriebenen Einstellungen bewirkt das Hinzufügen eines Rahmens um das
294294
Icon. Die Breite des Rahmens kann über `$icon-outlined-width` eingestellt werden.
295295

docs/pages/docs/configuration/theme/header.md renamed to docs/pages/configuration/theme/header.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Flexbox-Anweisung `justify-content`[^2] mit den Optionen:
143143
teilweise mit denen von CSS-Flexbox überlagern, können die `center` und `space-*` Anweisungen weiterhin verwendet
144144
werden.
145145

146-
Der Header kann mit folgendem CSS im [Skin](../../../guides/skin/introduction.md) auf CSS-Grid gestellt werden:
146+
Der Header kann mit folgendem CSS im [Skin](../../guides/skin/introduction.md) auf CSS-Grid gestellt werden:
147147
```css
148148
header > .inside {
149149
display: grid;

docs/pages/docs/configuration/theme/headings.md renamed to docs/pages/configuration/theme/headings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ In den nachfolgenden Abschnitten werden die nachfolgenden Einstellungen beschrie
250250
Wenn das [Global Spacing](#global-spacing-automatisch) nicht aktiviert wird, gelten folgende Regeln für den unteren
251251
Abstand (*Margin*) für Überschriften:
252252

253-
![Headline Spacing normal](../../../../assets/configuration/headline/headline-spacing.png){loading=lazy}
253+
![Headline Spacing normal](../../../assets/configuration/headline/headline-spacing.png){loading=lazy}
254254

255255
| Breakpoints | Small | Medium | Large |
256256
|-----------------------|----------------------------|------------------------------|------------------------------|
@@ -280,7 +280,7 @@ Abstand (*Margin*) für Überschriften:
280280
dies oft die einzig notwendige Einstellung ist. Die nachfolgende Tabelle zeigt an, welche der Config-Variablen genutzt
281281
wird.
282282

283-
![Headline Spacing global](../../../../assets/configuration/headline/headline-spacing-global.png){loading=lazy}
283+
![Headline Spacing global](../../../assets/configuration/headline/headline-spacing-global.png){loading=lazy}
284284

285285
| Breakpoints | Small | Medium | Large |
286286
|------------------------------------------|-----------------------------|------------------------------|------------------------------|

docs/pages/docs/configuration/theme/layout.md renamed to docs/pages/configuration/theme/layout.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ Typische Breakpoints sind beispielsweise für
2525
definiert, um ein konsistentes und benutzerfreundliches Erlebnis auf unterschiedlichen Geräten zu gewährleisten. Im
2626
Gegensatz zu anderen CSS-Frameworks legt der ThemeManager auch Wert auf Bildschirme, die über Full HD (1920 x 1080)
2727
hinausgehen.
28-
![Breakpoints des ThemeManagers](../../../../assets/configuration/layout/grid-breakpoints.png){loading=lazy}
28+
![Breakpoints des ThemeManagers](../../../assets/configuration/layout/grid-breakpoints.png){loading=lazy}
2929

3030
Der ThemeManager fügt sechs Breakpoints hinzu, die sich in den StyleManager-Einstellungen als Suffix der Konfigurationen
3131
widerspiegeln, zum Beispiel `(xs)`.
3232

33-
![Breakpoints im StyleManager](../../../../assets/configuration/layout/stylemanager-breakpoints.png){loading=lazy}
33+
![Breakpoints im StyleManager](../../../assets/configuration/layout/stylemanager-breakpoints.png){loading=lazy}
3434

3535
| Breakpoint | Bildschirmgröße | Geräte |
3636
|------------|----------------:|--------------------------:|
@@ -110,7 +110,7 @@ Diese Optionen erlauben die Auswahl eines [Breakpoints](#breakpoints) für die V
110110
und/oder
111111
rechte Spalte in der gleichen Reihe wie die Hauptspalte angezeigt werden.
112112

113-
![Verhalten des Layouts](../../../../assets/configuration/layout/layout-behavior.png){loading=lazy}
113+
![Verhalten des Layouts](../../../assets/configuration/layout/layout-behavior.png){loading=lazy}
114114

115115
Über `$layout-column-width-*` können die Breiten für die linke und rechte Spalte eingestellt werden. Mit
116116
`$layout-column-gutter` wird der Abstand zur Hauptspalte konfiguriert.
@@ -166,7 +166,7 @@ Hälfte des konfigurierten [Grid-Gutter](#grid). Möchte man diesen Abstand verg
166166
konfiguriert werden.
167167

168168
<figure markdown>
169-
![Äußeres Padding von Artikeln](../../../../assets/configuration/layout/article-outer-padding.png){loading=lazy width="375"}
169+
![Äußeres Padding von Artikeln](../../../assets/configuration/layout/article-outer-padding.png){loading=lazy width="375"}
170170
<figcaption>Padding am Bildschirmrand</figcaption>
171171
</figure>
172172

@@ -264,7 +264,7 @@ Ein Artikel dient hierbei immer als Grid-Container, der die Ausrichtung der Kind
264264
kann.
265265
Inhaltselemente lassen sich in das 12-Spalten-Raster einordnen.
266266

267-
![12er Grid](../../../../assets/configuration/layout/grid-columns-12.png){loading=lazy}
267+
![12er Grid](../../../assets/configuration/layout/grid-columns-12.png){loading=lazy}
268268
!!! danger "Spaltenanzahl von 12 ($grid-columns)"
269269

270270
Es wird nicht empfohlen, die Anzahl der Spalten von 12 zu ändern, da die Optionen des StyleManagers nicht

docs/pages/docs/configuration/theme/miscellaneous.md renamed to docs/pages/configuration/theme/miscellaneous.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Kompilieren für alle Breakpoints gelten. Nach der Generierung erfolgt die Benen
104104
In `$display-properties` können die gewünschten
105105
[Display-Eigenschaften](https://developer.mozilla.org/en-US/docs/Web/CSS/display) nacheinander eingetragen werden.
106106

107-
![Dynamisch generierte Display-Eigenschaften](../../../../assets/configuration/misc/display-properties.png){loading=lazy}
107+
![Dynamisch generierte Display-Eigenschaften](../../../assets/configuration/misc/display-properties.png){loading=lazy}
108108

109109
```
110110
none block flex table grid inline-block inline-flex inline-grid

docs/pages/docs/configuration/theme/overview.md renamed to docs/pages/configuration/theme/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Erscheinungsbild jeder Webseite nach Bedarf anzupassen.
1212
!!! info
1313

1414
Jeder Bezeichner einer einzustellenden Variable entspricht der jeweiligen
15-
[SCSS-Variable](https://sass-lang.com/guide/#variables), wodurch der Wert im [Skin](../../../guides/skin/introduction.md)
15+
[SCSS-Variable](https://sass-lang.com/guide/#variables), wodurch der Wert im [Skin](../../guides/skin/introduction.md)
1616
abgerufen werden kann.
1717

1818
---
@@ -22,7 +22,7 @@ Erscheinungsbild jeder Webseite nach Bedarf anzupassen.
2222
In Version 2.0 des Contao ThemeManagers wurde die Konfiguration angepasst, sodass die hier dokumentierte Reihenfolge der
2323
Theme-Konfiguration mit der im Contao-Backend übereinstimmt.
2424

25-
![Backend-Ansicht der Theme Konfiguration](../../../../assets/configuration/1_config.png)
25+
![Backend-Ansicht der Theme Konfiguration](../../../assets/configuration/1_config.png)
2626

2727
<div class="grid cards" markdown>
2828

docs/pages/docs/introduction/version.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)