Add some documentation

main
Anonymous Contributor 2023-09-15 19:00:48 +02:00
parent 3cd2452b68
commit 76abfa5c8d
2 changed files with 57 additions and 7 deletions

View File

@ -1,5 +1,30 @@
# v0.1.0
## 06/26/2023
# v0.1.0 (02.09.2023)
1. [](#new)
* ChangeLog started...
## Hinzugefügt
* Grundlegende Struktur des Templates
* CSS und Struktur der Original-Website
* Dynamischer Aufbau des Menüs
* Template für einfache Textseiten
* Twig-Funktion dirFiles
## Verändert
* Lokales Hosting der verwendeten Schriftarten
# v0.2.0 (15.09.2023)
## Hinzugefügt
* Module AutoSlideshow, SlideshowExt, TextBG und BoxList
* Blueprints für Theme-, Seiten- und Modul-Einstellungen
* Eigene Implementation von Animated Image
## Verändert
* Desktop- und Mobilversion der Navigationsleiste verbessert
* CSS optimiert
* jQuery aktualisiert
* Alle genutzten JavaScript-Komponenten neu implementiert
* Dynamisch eingebundene Logos
## Entfernt
* Abhängigkeiten, ungenutztes CSS und JavaScript der Original-Website
* Nicht zum Theme gehörende Bilder
* Twig-Funktion dirFiles

View File

@ -1,7 +1,32 @@
# Four Creative Theme
The **Four Creative** Theme is for [Grav CMS](http://github.com/getgrav/grav). This README.md file should be modified to describe the features, installation, configuration, and general usage of this theme.
Ein Theme für das [Grav CMS](http://github.com/getgrav/grav), das einer dynamischen, leichter zu erweiternden und pflegenden Umsetzung der ursprünglichen 4Creative-Website bietet.
## Description
## Features
4Creative theme for Grav
### Header und Footer
Jede Seite besitzt einen Header, der durch Herunterscrollen durch einen kompakteren "Sticky Header" ersetzt wird, und einen Footer mit dynamischem Copyright-Hinweis und Discord-Einladungslink.
Das zu verwendende Logo, der Einladungslink und die Discord-Buttons können in den Einstellungen des Themes festgelegt werden.
### Module
Die folgenden Module können einer modularen Website hinzugefügt werden:
| Name | Beschreibung |
| -------- | -------- |
| Autoslideshow | Automatisch ablaufende, einfache Bilder-Slideshow |
| Boxlist | Zeile aus Kästchen mit Bildern, Links, Titeln und kurzen Beschreibungstexten, für den Abschnitt "Unser Weltenverbund" der Startseite genutzt |
| Slideshowext | Erweiterte Slideshow mit Bildern, Texten und Links, die manuell durchschritten werden kann |
| Textbg | Normaler Text (Markdown) mit Hintergrundbild und/oder -Farbe |
### Optionale Komponenten
Das Theme liefert zwei optionale Komponenten mit, die standardmäßig deaktiviert sind, aber über die Theme-Konfiguration aktiviert werden können:
1. Cookie-Banner, das Nutzer auf das Setzen von Cookies hinweist. Grav setzt für normale Nutzer standardmäßig keine Cookies, weshalb diese Komponente standardmäßig nicht aktiviert ist.
2. Skript, das den Aufruf des Kontextmenüs für Bilder verhindert. Dies erschwert unerfahrenen Nutzern das Stehlen von Seiteninhalten.
## Installation
Vorausgesetzt wird eine vorhandene Grav-Installation (siehe [hier](https://learn.getgrav.org/17/basics/installation)).
Das Theme kann direkt installiert werden, indem unter `user/themes` in der Grav-Verzeichnisstruktur das Verzeichnis `four-creative` erstellt und der Inhalt dieses Repository dort hineinkopiert wird.