Skip to content

Commit

Permalink
Prepare docs
Browse files Browse the repository at this point in the history
- relative links
- setup edit uri
- update metadata
  • Loading branch information
zoglo committed Jan 9, 2024
1 parent ad38f86 commit 4c6fd6b
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 27 deletions.
22 changes: 11 additions & 11 deletions docs/pages/docs/configuration/theme/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Erscheinungsbild jeder Webseite nach Bedarf anzupassen.

!!! info
Jeder Bezeichner einer einzustellenden Variable entspricht der jeweiligen
[SCSS-Variable](https://sass-lang.com/guide/#variables), wodurch der Wert im [Skin](/pages/docs/configuration/skin)
[SCSS-Variable](https://sass-lang.com/guide/#variables), wodurch der Wert im [Skin](../skin.md)
abgerufen werden kann.

## Konfigurationsstruktur
Expand All @@ -19,62 +19,62 @@ Theme-Konfiguration mit der im Contao-Backend übereinstimmt.

<div class="grid cards" markdown>

- :octicons-globe-24: __[Global](/pages/docs/configuration/theme/global/)__
- :octicons-globe-24: __[Global](global.md)__

---

Die globalen Einstellungen betreffen grundlegende Aspekte wie Farben und Root-Schriftgröße.

- :octicons-typography-24: __[Schriften](/pages/docs/configuration/theme/fonts/)__
- :octicons-typography-24: __[Schriften](fonts.md)__

---

In diesem Abschnitt können die Typografie sowie Links angepasst werden.

- :octicons-heading-24: __[Überschriften](/pages/docs/configuration/theme/headings/)__
- :octicons-heading-24: __[Überschriften](headings.md)__

---

Hier erfolgt die Konfiguration von Schriftgrößen, Farben und weiteren Optionen für Überschriften (*h1* - *h6*).

- :material-button-pointer: __[Buttons](/pages/docs/configuration/theme/buttons/)__
- :material-button-pointer: __[Buttons](buttons.md)__

---

Änderungen am Erscheinungsbild von Buttons und Links, für die der Button-Stil über den StyleManager festgelegt wurde.

- :octicons-table-24: __[Komponenten](/pages/docs/configuration/theme/components/)__
- :octicons-table-24: __[Komponenten](components.md)__

---

Dieser Bereich ermöglicht die Anpassung des Aussehens von Cards (Box), Linien, Tabellen und der Icon-Komponente.

- :material-form-textbox: __[Formular](/pages/docs/configuration/theme/form/)__
- :material-form-textbox: __[Formular](form.md)__

---

Über die Formular-Konfiguration kann das gesamte Erscheinungsbild von `form`, `select`, `input`, `textarea`, `label`,
und `legend` festgelegt werden.

- :material-navigation-variant-outline: __[Module](/pages/docs/configuration/theme/modules/)__
- :material-navigation-variant-outline: __[Module](modules.md)__

---

Einstellungen für Navigationen und die Breadcrumb-Navigation.

- :material-page-layout-header: __[Header](/pages/docs/configuration/theme/header/)__
- :material-page-layout-header: __[Header](header.md)__

---

Dieser Abschnitt behandelt die Konfiguration des `<header>`-Elements.

- :material-selection: __[Sonstiges](/pages/docs/configuration/theme/miscellaneous/)__
- :material-selection: __[Sonstiges](miscellaneous.md)__

---

Einstellungen für Textauswahl-Farbe, Schatten und Seitenverhältnisse von Bildern.

- :material-view-grid-plus-outline: __[Layout](/pages/docs/configuration/theme/miscellaneous/)__
- :material-view-grid-plus-outline: __[Layout](layout.md)__

---

Expand Down
16 changes: 8 additions & 8 deletions docs/pages/docs/installation/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ generieren.
![Compiler Report](../../../assets/setup/3_theme_6.png)
Nach erfolgreichem Abschluss wirst du zum Compiler-Report weitergeleitet. Hier werden drei Dateien erstellt:

| Datei | Funktion |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------|
| _icon.css | Beinhaltet das generierte Stylesheet der [Icons](configuration/icon-set), die über die Systemeinstellungen eingebunden wurden. |
| _background.css | Beinhaltet das generierte Stylesheet der [Hintergrundbilder](configuration/backgrounds), die über die Dateiverwaltung festgelegt wurden. |
| _theme.css | Enthält das [anpassbare Framework](configuration/theme) des Contao ThemeManagers. |
| Datei | Funktion |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------|
| _icon.css | Beinhaltet das generierte Stylesheet der [Icons](../configuration/icon-set.md), die über die Systemeinstellungen eingebunden wurden. |
| _background.css | Beinhaltet das generierte Stylesheet der [Hintergrundbilder](../configuration/backgrounds.md), die über die Dateiverwaltung festgelegt wurden. |
| _theme.css | Enthält das [anpassbare Framework](../configuration/theme/overview.md) des Contao ThemeManagers. |

## Layout(s) erstellen
In diesem Abschnitt geht es um die Anpassung der Layouts, die für eine optimale Nutzung des ThemeManagers erforderlich
Expand Down Expand Up @@ -86,7 +86,7 @@ Dieses Layout bedient sich zusätzlich der in Contao integrierten Layoutbereiche
- Rechte Spalte

!!! info
Die in der [Theme-Konfiguration](/pages/docs/configuration/theme/global/) zu findende Palette **Überschriften (Inhaltsbereich)** dient lediglich diesem Layout.
Die in der [Theme-Konfiguration](../configuration/theme/global.md) zu findende Palette **Überschriften (Inhaltsbereich)** dient lediglich diesem Layout.

Um sicherzustellen, dass Artikel sowohl ober- als auch unterhalb des Hauptspaltenbereichs angezeigt werden können,
kannst du die folgenden Schritte befolgen.
Expand Down Expand Up @@ -129,7 +129,7 @@ Die Theme-Konfiguration lässt sich nun über die Theme-Übersicht mithilfe des

___

Im nächsten Abschnitt [Theme konfigurieren](configuration/theme) erfährst du im Detail, welche Optionen in der
Im nächsten Abschnitt [Theme konfigurieren](../configuration/theme/overview.md) erfährst du im Detail, welche Optionen in der
Theme-Konfiguration verfügbar sind und wie sie das Aussehen und Verhalten deines Themes beeinflussen.

[^1]:
Expand All @@ -142,5 +142,5 @@ diese Datei an erster Stelle eingebunden werden. In bestimmten Ausnahmen wie z.B

[^2]:
Es empfiehlt sich die _background.css in der Reihenfolge immer als
letzte Stylesheet-Datei einzubinden, damit das Überschreiben dieser über einen eigenen [Skin](configuration/skin)
letzte Stylesheet-Datei einzubinden, damit das Überschreiben dieser über einen eigenen [Skin](../configuration/skin.md)
einfacher ist.
6 changes: 3 additions & 3 deletions docs/pages/docs/introduction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ ___
Contao ThemeManager entspricht. Erfahre mehr über die notwendigen Voraussetzungen, um den Contao ThemeManager nutzen zu
können.

[:octicons-arrow-right-24: Systemanforderungen](/pages/docs/installation/system/)
[:octicons-arrow-right-24: Systemanforderungen](../installation/system.md)

- :octicons-download-24:{ .lg .middle } __Download und Installation__

Expand All @@ -33,7 +33,7 @@ ___
Hier erfährst du, wie du den Contao ThemeManager herunterladen und erfolgreich in deine Contao-Installation integrieren
kannst. Schritt-für-Schritt-Anleitungen helfen dir, das Plugin reibungslos zu installieren.

[:octicons-arrow-right-24: Installation](/pages/docs/installation/install/)
[:octicons-arrow-right-24: Installation](../installation/install.md)

- :octicons-book-24:{ .lg .middle } __Ersteinrichtung__

Expand All @@ -42,7 +42,7 @@ ___
Nach der Installation ist es wichtig, den Contao ThemeManager korrekt einzurichten. Entdecke, wie du die ersten
Konfigurationsschritte durchführst und das Theme-Management optimal auf deine Bedürfnisse abstimmst.

[:octicons-arrow-right-24: Ersteinrichtung](/pages/docs/installation/setup/)
[:octicons-arrow-right-24: Ersteinrichtung](../installation/setup.md)

- :octicons-device-desktop-24:{ .lg .middle } __ThemeManager Demo__

Expand Down
13 changes: 8 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,17 @@ nav:
# - pages/extensions/index.md

# Project information
site_url: https://contao-thememanager.github.io/
site_author: Daniele Sciannimanica
site_url: https://contao-thememanager.github.io/docs/
site_author: co-authored by Daniele Sciannimanica, Sebastian Zoglowek
site_description: >-
Contao ThemeManager Dokumenation
Contao ThemeManager Dokumentation
# Repository
repo_name: contao-thememanager/core
repo_url: https://github.com/contao-thememanager/core
repo_name: contao-thememanager/docs
repo_url: https://github.com/contao-thememanager/docs

# Edit
edit_uri: https://github.com/contao-thememanager/docs/edit/main/docs

# Copyright
copyright: Copyright &copy; 2024 Oveleon
Expand Down

0 comments on commit 4c6fd6b

Please sign in to comment.