Was ist PUG (Jade)?
PUG, ehemals bekannt als Jade, ist ein minimalistischer Template-Engine, der die Erstellung von HTML-Markup vereinfacht. Mit PUG kannst du dich auf die Struktur und den Inhalt deiner Website konzentrieren, während die Engine automatisch den entsprechenden HTML-Code generiert.
Vorteile von PUG:
- Konzentriere dich auf den Inhalt: PUG eliminiert redundante HTML-Markup-Tags, sodass du dich auf die Erstellung ansprechender Inhalte konzentrieren kannst.
- Schlanker Code: PUG-Code ist prägnant und übersichtlich, was die Wartung und Fehlerbehebung vereinfacht.
- Wiederverwendbarkeit: Durch die Verwendung von Partials und Mixins kannst du Codeblöcke wiederverwenden und so die Entwicklung beschleunigen.
- Erweiterbar: PUG ist eine Open-Source-Engine, die du durch Plugins und Add-Ons erweitern kannst, um ihren Funktionsumfang zu erweitern.
Struktur von PUG-Dateien:
PUG-Dateien werden mit der Erweiterung .pug gespeichert. Sie bestehen aus:
-
Elemente: Definieren HTML-Elemente wie
<div>,<p>und<ul>. -
Attributwerte: Werden in doppelten Anführungszeichen angegeben, z. B.
id="header". - Indentierung: Wird anstelle von Klammern zur Gruppierung von Elementen verwendet.
- Kommentare: Beginnen mit einem Doppelkreuz (#).
Vorteile der Verwendung von PUG
PUG bietet eine Vielzahl von Vorteilen, die es zu einem idealen Werkzeug für die Erstellung von Websites machen, darunter:
Verbesserte Lesbarkeit und Wartbarkeit
PUG verwendet eine deklarative Syntax, die es dir ermöglicht, deinen Code in einer für Menschen lesbaren Weise zu schreiben. Im Gegensatz zu HTML, das viele Tags und Attribute enthält, verwendet PUG eine einfachere Syntax, die es dir erleichtert, deinen Code zu verstehen und zu warten.
Reduzierte Code-Größe
PUG erzeugt kompakteren Code als HTML. Dadurch werden die Ladezeiten der Website verkürzt und die Bandbreite eingespart. Dies ist besonders vorteilhaft für mobile Geräte mit begrenzter Bandbreite.
Wiederverwendbarkeit von Komponenten
PUG unterstützt die Verwendung von Partials, mit denen du Codeblöcke wiederverwenden kannst. Dies spart Zeit und reduziert die Code-Duplizierung. Du kannst Partials für Header, Footer und andere gemeinsame Komponenten erstellen und sie dann in deinen PUG-Vorlagen einfügen.
Unterstützung für dynamische Inhalte
PUG kann mit Datenquellen wie JSON oder Datenbanken verbunden werden. Dies ermöglicht es dir, dynamische Inhalte zu generieren, z. B. Produktlisten oder Benutzerprofile. Du kannst PUG-Variablen und Kontrollstrukturen verwenden, um die Ausgabe basierend auf den Daten zu steuern.
Erweiterbarkeit
PUG ist ein erweiterbares Framework, das es dir ermöglicht, Plugins und Mixins zu verwenden, um seine Funktionalität zu erweitern. Dies ermöglicht es dir, PUG an deine spezifischen Anforderungen anzupassen. Beispielsweise kannst du Plugins verwenden, um SASS oder LESS in deinen PUG-Dateien zu kompilieren.
Integration mit CSS-Präprozessoren
PUG kann nahtlos in CSS-Präprozessoren wie SASS oder LESS integriert werden. Dies ermöglicht es dir, Stylesheets mit erweiterten Funktionen wie Variablen, Mixins und Nesting zu erstellen. Du kannst PUG-Variablen in deinen Stylesheets verwenden, um die Konsistenz und Wiederverwendbarkeit zu verbessern.
Installation und Einrichtung von PUG
Um mit PUG zu arbeiten, musst du es auf deinem System installieren. Hier ist eine Schritt-für-Schritt-Anleitung:
Installation
Node.js und npm:
- Installiere Node.js von der offiziellen Website: https://nodejs.org/en/
- Installiere npm (Node Package Manager) mit folgendem Befehl:
npm install -g npm
PUG installieren:
- Installiere PUG mit npm:
npm install --global pug
Globale und lokale Installation
Du kannst PUG entweder global oder lokal für ein bestimmtes Projekt installieren.
- Globale Installation: Installiert PUG global auf deinem System. Du kannst es dann von überall aus verwenden.
- Lokale Installation: Installiert PUG nur für ein bestimmtes Projektverzeichnis. Andere Projekte auf deinem System sind davon nicht betroffen.
Auswahl der Installationsmethode
Die Wahl der Installationsmethode hängt von deinen Anforderungen ab:
- Wenn du PUG für mehrere Projekte verwenden möchtest, ist eine globale Installation empfehlenswert.
- Wenn du PUG nur für ein bestimmtes Projekt benötigst, ist eine lokale Installation sinnvoller, um die Abhängigkeiten des Projekts zu isolieren.
Einrichtung
Globale Einrichtung:
Nach der globalen Installation ist PUG verfügbar, indem du pug im Terminal aufrufst.
Lokale Einrichtung:
- Wechsle in das Projektverzeichnis.
- Initialisiere ein neues npm-Projekt, indem du folgenden Befehl ausführst:
npm init -y - Installiere PUG in das Projekt:
npm install --save-dev pug
Konfigurationsdatei:
Du kannst eine .pug-rc-Konfigurationsdatei erstellen, um globale Einstellungen für PUG festzulegen. Beispielsweise kannst du die Standardeinstellung für Einzüge ändern:
# .pug-rc
indentWidth: 4
Nützliche Links
PUG-Syntax verstehen
Um PUG effektiv zu nutzen, ist es wichtig, die Syntax zu verstehen. PUG verwendet eine einfache, aber ausdrucksstarke Sprache, die stark von HTML beeinflusst ist.
Kommentaren
Kommentiere deinen Code, um anderen oder deinem zukünftigen Ich Hinweise zu geben. PUG verwendet das gleiche Kommentarformat wie HTML und CSS, d. h. // für einzeilige Kommentare und /* ... */ für mehrzeilige Kommentare.
Tabulatoren und Einrückungen
PUG stellt HTML-Elemente und -Attribute hierarchisch dar. Tabulatoren oder Leerzeichen werden verwendet, um diese Hierarchie anzuzeigen. Ein Tabulator oder zwei Leerzeichen stehen für eine Ebene. Du kannst deinen eigenen Tabulatoren- oder Einrückungsstil wählen, aber sei konsequent.
Beispiel:
ul
li
a(href="#") Link 1
li
a(href="#") Link 2
Blöcke und Inline-Elemente
In PUG werden Elemente entweder als Blöcke oder Inline-Elemente definiert. Blöcke beginnen mit einer neuen Zeile und werden durch Einrückung oder Tabulatoren eingerückt, während Inline-Elemente in derselben Zeile wie das übergeordnete Element geschrieben werden.
-
Blockelemente:
div,ul,p -
Inline-Elemente:
span,a,button
Beispiel:
div
p Hello, world!
a(href="#") Learn more
Attribute
Attribute werden innerhalb von Elementen definiert und ähneln HTML-Attributen. Du kannst jedoch die Syntax von PUG nutzen, um Attribute einfacher und prägnanter zu definieren.
-
HTML-Attribut:
<div id="container"></div> -
PUG-Attribut:
div#container
Beispiel:
a(href="#", class="btn") Button
Variablen und Kontrollstrukturen
PUG unterstützt Variablen und Kontrollstrukturen, mit denen du dynamische Inhalte erstellen kannst. Weitere Informationen zu diesem Thema findest du im Abschnitt "Verwenden von PUG-Variablen und Kontrollstrukturen".
Partials
Partials sind wiederverwendbare Codeblöcke, die die Entwicklung und Wartung erleichtern. Weitere Informationen zu diesem Thema findest du im Abschnitt "Erstellen von Layouts und Partials in PUG".
Konvertieren von PUG in HTML
Nachdem du deine PUG-Datei erstellt hast, musst du sie konvertieren, um den entsprechenden HTML-Code zu erhalten. Es gibt mehrere Möglichkeiten, diese Konvertierung durchzuführen:
Mit dem PUG-Kommandozeilentool
Du kannst das Kommandozeilentool von PUG verwenden, um deine PUG-Datei in HTML zu konvertieren. Installiere das Tool global mit dem folgenden Befehl:
npm install -g pug
Navigiere anschließend zum Verzeichnis deiner PUG-Datei und führe folgenden Befehl aus:
pug deine-pug-datei.pug -o deine-html-datei.html
Mit einem PUG-Plugin für deinen Editor
Es stehen zahlreiche PUG-Plugins für verschiedene Code-Editoren wie Sublime Text, Atom und Visual Studio Code zur Verfügung. Diese Plugins können die Konvertierung automatisieren, sodass du den Befehl nicht jedes Mal manuell ausführen musst.
Mit einem Online-PUG-Konverter
Du kannst auch einen Online-PUG-Konverter wie Pug2HTML oder CodeBeautify verwenden, um deine PUG-Datei in HTML zu konvertieren. Diese Tools sind praktisch, wenn du keinen PUG-Installer auf deinem System hast oder wenn du nur schnell einen PUG-Codeausschnitt konvertieren möchtest.
Unabhängig von der gewählten Methode erhältst du nach der Konvertierung eine HTML-Datei, die den Inhalt deiner PUG-Datei widerspiegelt.
Verwenden von PUG-Variablen und Kontrollstrukturen
Mit PUG kannst du Variablen und Kontrollstrukturen verwenden, um deinen Code flexibler und wiederverwendbarer zu gestalten.
PUG-Variablen
Variablen sind in PUG mit einem Dollarzeichen ($) gekennzeichnet. Du kannst sie deklarieren und ihnen Werte zuweisen, indem du Folgendes verwendest:
$variable = 'Wert'
Du kannst auf Variablen überall in deinem PUG-Code zugreifen, indem du ihren Namen verwendest:
p Hello, $variable!
Kontrollstrukturen
PUG unterstützt verschiedene Kontrollstrukturen, darunter:
-
Bedingungen (if-else-Statements): Du kannst Bedingungen mit der
if-Anweisung prüfen und bei Bedarf alternative Blöcke ausführen:
if ($condition)
p Bedingung ist wahr
else
p Bedingung ist falsch
- Schleifen (each-Statements): Du kannst Schleifen verwenden, um Arrays oder Objekte zu durchlaufen und ihren Inhalt zu rendern:
each item in $array
p #{item}
- Mixins: Mixins sind wiederverwendbare Codeblöcke, die du über Funktionen mit Parametern deklarieren kannst:
mixin wrapContents($content)
div
$content
Du kannst Mixins wie folgt aufrufen:
+wrapContents('Hello, world!')
Erstellen von Layouts und Partials in PUG
Was sind Layouts?
Layouts sind Vorlagen, die das Grundgerüst deiner Website definieren. Sie enthalten gemeinsame Elemente wie Kopf- und Fußzeilen, Navigation und Seiteneinschränkungen. Durch die Verwendung von Layouts kannst du eine konsistente Struktur für alle Seiten deiner Website sicherstellen.
Was sind Partials?
Partials sind wiederverwendbare Codeblöcke, die in mehrere Seiten eingefügt werden können. Sie eignen sich für die gemeinsame Nutzung von Headern, Fußzeilen und anderen wiederkehrenden Elementen, wodurch du Zeit und Code-Duplizierung sparst.
Einrichten von Layouts
Erstelle eine neue .pug-Datei im Stammverzeichnis deines Projekts und benenne sie layout.pug. Diese Datei wird dein Hauptlayout enthalten.
Erstellen eines Layouts
<!DOCTYPE html>
<html>
<head>
<title>Deine Website</title>
<!-- Dein Kopfzeilencode -->
</head>
<body>
<header>
<h1>Dein Website-Name</h1>
<nav>
<!-- Deine Navigationslinks -->
</nav>
</header>
<main>
<!-- Dein Seiteninhalt -->
</main>
<footer>
<!-- Dein Fußzeilencode -->
</footer>
</body>
</html>
Verwenden von Partials
Erstelle eine neue .pug-Datei im Ordner partials und benenne sie header.pug. Diese Datei wird deinen Header-Code enthalten.
// partials/header.pug
<h1>Dein Website-Name</h1>
<nav>
<!-- Deine Navigationslinks -->
</nav>
Einbinden von Partials in Layouts
In deinem Layout kannst du Partials mithilfe von include-Tags einbinden.
// layout.pug
<!DOCTYPE html>
<html>
<head>
<title>Deine Website</title>
<!-- Dein Kopfzeilencode -->
</head>
<body>
<!-- Partials einbinden -->
include partials/header
<main>
<!-- Dein Seiteninhalt -->
</main>
<!-- Partials einbinden -->
include partials/footer
</body>
</html>
Vorteile der Verwendung von Layouts und Partials
- Konsistenz: Sicherstelle eine einheitliche Struktur und ein einheitliches Erscheinungsbild auf allen Seiten deiner Website.
- Wiederverwendbarkeit: Vermeide Code-Duplizierung durch das Teilen von Headern, Fußzeilen und anderen Elementen über Partials.
- Wartbarkeit: Änderungen am Layout oder an Partials wirken sich sofort auf alle Seiten aus, die sie verwenden.
- Entwicklungsgeschwindigkeit: Spare Zeit, indem du vorgefertigte Vorlagen und wiederverwendbare Codeblöcke verwendest.
Fehlersuche in PUG-Code
Beim Entwickeln mit PUG kann es gelegentlich zu Fehlern kommen. Die folgenden Tipps helfen dir, diese zu erkennen und zu beheben:
Fehlermeldungen verstehen
Wenn PUG einen Fehler feststellt, gibt es eine Fehlermeldung aus. Diese Meldung enthält in der Regel folgende Informationen:
- Zeilennummer: Die Zeile im PUG-Dokument, in der der Fehler auftritt.
- Fehlertyp: Die Art des Fehlers, z. B. Syntaxfehler oder logischer Fehler.
- Fehlerbeschreibung: Eine kurze Erklärung des Fehlers.
Fehlerbehebung
Um einen PUG-Fehler zu beheben, befolge diese Schritte:
- Überprüfe die Zeilenumbrüche: PUG ist sehr empfindlich gegenüber Zeilenumbrüchen. Stelle sicher, dass die Einrückungen und Zeilenumbrüche in deinem Code korrekt sind.
- Überprüfe die Syntax: Vergewissere dich, dass die PUG-Syntax korrekt ist. Überprüfe, ob du öffnende und schließende Tags korrekt verwendest und ob alle erforderlichen Attribute vorhanden sind.
- Überprüfe die Logik: Überzeuge dich davon, dass die Logik in deinem PUG-Code korrekt ist. Überprüfe, ob deine Variablen korrekt deklariert und verwendet werden und ob deine Kontrollstrukturen ordnungsgemäß funktionieren.
- Verwende ein Debugging-Tool: Es gibt verschiedene Debugging-Tools für PUG, mit denen du Fehler in deinem Code schnell identifizieren kannst. Ein beliebtes Tool ist der Pug-linter, der Syntaxfehler und Stilprobleme erkennt.
- Suche online nach Hilfe: Wenn du den Fehler selbst nicht beheben kannst, kannst du online nach Hilfe suchen. Es gibt viele Ressourcen und Communities, die PUG-Unterstützung anbieten.
Beste Praktiken für die Verwendung von PUG
Um die Effizienz und Wartbarkeit deiner PUG-Projekte zu maximieren, befolge diese bewährten Praktiken:
Organisation
- Verwende Layouts und Partials: Teile deinen Code in wiederverwendbare Komponenten auf, um redundanten Code zu vermeiden. Layouts definieren das allgemeine Skelett deiner Seiten, während Partials kleinere Codeblöcke für wiederkehrende Elemente wie Kopf- und Fußzeilen darstellen.
- Indentation: Verwende Einrückungen konsistent, um die Lesbarkeit und Wartbarkeit deines Codes zu verbessern. PUG unterstützt sowohl Tabulatoren als auch Leerzeichen zur Einrückung, aber wähle eine Methode und halte dich daran.
Syntax
- Vermeide Inline-CSS: Verwende CSS-Dateien, um die Stile deiner Website zu verwalten. Die Inline-Angabe von CSS in PUG kann deinen Code unübersichtlich machen.
- Nutze Mixins: Mixins sind wiederverwendbare Codeblöcke, mit denen du allgemeine Stile und Verhaltensweisen in deinem Code definieren kannst. Sie helfen dir, Konsistenz aufrechtzuerhalten und Redundanzen zu reduzieren.
- Verwende Filter: PUG bietet eine Reihe von Filtern, die die Ausgabe deines Codes manipulieren können. Diese Filter können dir dabei helfen, deinen Code zu kürzen und die Lesbarkeit zu verbessern.
Zusammenarbeit und Dokumentation
- Verwende einen Code-Editor mit PUG-Unterstützung: Code-Editoren wie Visual Studio Code bieten Hervorhebung der Syntax, automatische Vervollständigung und andere Funktionen, die dir bei der Arbeit mit PUG helfen können.
- Dokumentiere deinen Code: Kommentiere deinen PUG-Code, um seine Funktion zu erklären und seine Verwendung für andere zu erleichtern. Wenn du mit einem Team zusammenarbeitest, kann die Dokumentation sicherstellen, dass jeder die Codebasis versteht.
Leistung
- Minimiere deinen Code: Minimiere deinen PUG-Code, bevor du ihn auf den Produktionsserver hochlädst. Dies entfernt Leerzeichen, Kommentare und andere unnötige Zeichen, um die Ladezeit der Seite zu verkürzen.
- Cache deine Vorlagen: Wenn möglich, cache deine PUG-Vorlagen. Dadurch wird die Renderzeit deiner Seiten reduziert und die Leistung deiner Website verbessert.
Responsive Website-Erstellung mit PUG
Die Erstellung responsiver Websites ist mit PUG ein Kinderspiel. PUG bietet mehrere Funktionen, die die Definition von Layouts und die Anpassung an unterschiedliche Bildschirmgrößen erleichtern.
Verwendung von Medienabfragen
Medienabfragen ermöglichen es dir, verschiedene Stile auf die Seite anzuwenden, abhängig von den Medienmerkmalen wie Bildschirmgröße, Ausrichtung und Auflösung. In PUG kannst du Medienabfragen verwenden, indem du das media-Attribut zu einem style-Tag hinzufügst.
style(media="screen and (max-width: 768px)")
body {
font-size: 1.2rem;
}
Verwendung von Flexbox und Grid
Flexbox und Grid sind moderne CSS-Layoutsysteme, die es dir ermöglichen, Inhalte auf flexible und reaktionsschnelle Weise zu positionieren. PUG unterstützt die Verwendung von Flexbox und Grid über die display-Eigenschaft.
.container
display flex
flex-direction: column
align-items: center
justify-content: center
Verwenden von Partials und Includes
Partials sind wiederverwendbare Codeblöcke, die in verschiedenen Teilen deiner Website verwendet werden können. Dies ist nützlich für die gemeinsame Nutzung von Layoutkomponenten, Headern und Footern. In PUG kannst du Partials mit dem include-Tag importieren.
include partials/header
include partials/footer
Verwendung von Bedingungen und Schleifen
PUG bietet Bedingungen und Schleifen, mit denen du dynamischen Inhalt erstellen und verschiedene Layouts basierend auf bestimmten Parametern rendern kannst. Dies ist hilfreich, um responsive Breakpoints oder bedingte Inhalte basierend auf Benutzerinteraktion zu definieren.
each item in items
if item.isFeatured
p.featured #{item.name}
else
p #{item.name}
Durch die Verwendung dieser Funktionen in PUG kannst du mühelos responsive Websites erstellen, die sich an alle Bildschirmgrößen anpassen und eine optimale Benutzererfahrung bieten.