Baue jemandem eine persönliche Website mit diesem Theme
Dieses Theme ist aus Daten zusammengesetzt, nicht aus Vorlagen. Fast jede Änderung, die jemand wünscht, ist eine Änderung an _config.yml plus einer Datei, die in einen Ordner gelegt wird – wenn du dabei bist, ein Layout zu bearbeiten, lies zuerst dieses Dokument, denn der gewünschte Hook existiert wahrscheinlich bereits.
1. Der schnellste Weg: der Setup-Assistent
npm run setup # öffnet ein lokales Formular, schreibt _config.yml, sichert die alte Version
Er bindet nur an 127.0.0.1, lädt niemals etwas hoch und kopiert alles, was er ersetzt, zuerst in .imprint-backup/<timestamp>/. Er füllt die aktuellen Werte aus der Konfiguration vor, daher kann er später bedenkenlos erneut ausgeführt werden.
Der Assistent umfasst Identität, Akzentfarbe, Kopf- und Fußzeile, Navigation, soziale Links, Sammlungen, Werbung, Analysen, den Newsletter-Endpunkt und die Domain. Er deckt bewusst nicht die Seitenzusammensetzung pro Sammlung ab – diese Schlüssel werden unverändert übernommen (siehe §4).
Danach:
npm run dev # http://localhost:4000
npm run check # Diagnose + Produktionsbuild
2. Veröffentlichen auf username.github.io
- Erstelle ein Repository mit dem genauen Namen
username.github.io(eine Benutzerseite) oder einem beliebigen Namen für eine Projektseite. - Pushe diesen Baum nach
main. - Einstellungen → Pages → Quelle: GitHub Actions.
.github/workflows/jekyll.yml baut mit Ruby 3.4 und deployt _site/. Es übergibt --baseurl "${{ steps.pages.outputs.base_path }}", sodass der gleiche Workflow sowohl für eine Benutzerseite (leerer Basispfad) als auch für eine Projektseite (/repo-name/) korrekt ist – hart codiere baseurl nicht.
CNAME enthält die benutzerdefinierte Domain. Keine benutzerdefinierte Domain → lösche die Datei; der Assistent erledigt das für dich, wenn du das Domain-Feld leer lässt.
3. Hinzufügen einer Sammlung
Eine Sammlung ist eine Art von Inhalt: ein Blog, ein Portfolio, ein Podcast, ein Regal mit Ausrüstung. Füge eine in _config.yml unter collections: hinzu:
rezepte:
output: true
title: Rezepte
singular: Rezept
description: "Ein Satz über diese Sammlung."
permalink: /rezepte/:name/
landing: /rezepte/
icon: cooking-pot # beliebiger Name von phosphoricons.com
schema: Recipe # schema.org-Typ für JSON-LD
card: blog # welches Kartendesign (siehe §5)
hero: { pattern: dots } # die Landing-Heldensektion; `hero: false` für den kompakten Kopf
image: "/assets/img/covers/rezepte.svg"
single: # woraus eine Eintragsseite besteht (siehe §4)
lead: cover
parts: [breadcrumbs, head, lead, prose, tags, share, ask, author, nav]
widgets: [toc, collection, about]
Danach:
mkdir _rezepte # der Ordner, den Jekyll liest
# eine Landing-Seite, die sie auflistet:
printf -- '---\nlayout: page\ntitle: Rezepte\npermalink: /rezepte/\nlist_collection: rezepte\n---\n' > rezepte.html
npm run thumbs # zeichnet das Cover-Bild für die neue Sammlung
npm run doctor sagt dir, ob du einen dieser Schritte vergessen hast.
Das Theme enthält dreizehn: posts, portfolio, videos, snippets, prompts, webseries + episodes, courses + lessons, podcast, newsletter, travel, uses. Eine Kindersammlung (eine Episode, eine Lektion) gehört zu ihrem Elternteil durch einen Slug im Frontmatter – series: oder course:.
4. Ändern der Zusammensetzung einer Eintragsseite
Das ist der Teil, bei dem Leute meist denken, sie bräuchten ein neues Layout. Tun sie nicht.
single:
lead: portfolio # _includes/leads/portfolio.html
parts: [breadcrumbs, head, lead, prose, tags, share, ask, comments, author, nav]
widgets: [details, toc, collection, cta]
sidebar: true
parts→_includes/single/<name>.html, in der angegebenen Reihenfolge gestapeltwidgets→_includes/widgets/<name>.html, in der Seitenleistelead→_includes/leads/<name>.html(nonefür keinen Lead)
Erfinde einen Teil, indem du eine Datei ablegst und sie benennst. Es wird kein Layout bearbeitet. Jeder einzelne Eintrag kann alle drei in seinem eigenen Frontmatter überschreiben.
Mitgelieferte Teile: breadcrumbs head toc-mobile lead prose tags share ask comments author nav episodes lessons siblings.
Widgets: toc details collection about cta share subscribe ad.
Leads: cover video prompt snippet portfolio series audio.
5. Kartendesigns
card: <name> auf einer Sammlung wählt _includes/cards/<name>.html. Mitgeliefert: blog (redaktionell), portfolio (Repo-Karte), video (Player), snippet (Code-Fenster), prompt (Chat-Fenster), webseries (Porträt-Poster), episode, course, lesson, podcast, issue, trip, product. Ohne Angabe wird auf blog zurückgegriffen, sodass eine neue Sammlung richtig aussieht, bevor sie ein eigenes Design hat.
Karten in einer Gitterzeile haben immer die gleiche Höhe. .im-cards dehnt jedes Element und der Kartenkörper nimmt den Überschuss auf – eine neue Karte muss also nur flex: 1 auf ihren Körper und margin-top: auto auf ihren Fuß setzen.
6. Tag-Seiten
_plugins/tag_pages.rb schreibt eine Seite pro Tag unter /tags/<slug>/, und zwar über alle Sammlungen hinweg – Jekylls eigenes site.tags sieht nur Beiträge, was auf einer Website, die auch Filme und Ausrüstung taggt, leise nur ein Drittel von dem anzeigen würde, was den Tag trägt. Tags werden nach Slug gruppiert, sodass Analytics und analytics ein Thema sind.
Ein Generator in _plugins/ läuft immer dann, wenn Jekyll von uns aufgerufen wird, was .github/workflows/jekyll.yml tut. Er würde nicht unter GitHub's Legacy-Modus "Build from a branch" laufen; setze dort tag_pages: false und die Tag-Links fallen auf Anker auf /tags/ zurück.
7. Hausstil – vor dem Schreiben von CSS lesen
Das Theme folgt dem Im Design System und hat genau zwei Interaktionen:
- HOVER – das Element FÜLLT (
--im-hover-bg). Nichts schärft einen Rand, nichts wächst um drei Prozent, nichts ruht auf einem Schlagschatten. - CURRENT – "du bist hier": eine stärkere Füllung und eine festere Bezeichnung (
--im-current-bg/-fg/-weight). Es ist nie eine Farbänderung.
Der Akzent ist für den primären Button, den Hover eines Links, den Fokusring, die Auswahl und den abgeleiteten Farbton jeder Sammlung – und sonst nichts. Ein gefüllter Button und eine Karte heben beide genau einen Pixel und werfen einen Hauch von Schatten.
Alles ist eine benutzerdefinierte Eigenschaft --im-*; nichts ist eine Literalfarbe. _sass/im/abstracts/_mixins.scss enthält beide Interaktionen, einmal geschrieben.
8. Die Befehle
npm run setup # das Browser-Setup-Formular
npm run dev # lokaler Server + Live-Reload
npm run build # Produktionsbuild nach _site/
npm run new # Gerüst für einen Eintrag in einer beliebigen Sammlung
npm run thumbs # (neu) zeichnet die generierte Cover-Kunst aus der Akzentfarbe
npm run doctor # prüft die Konfiguration auf Fehler, die einen Build zerstören
npm run test # die Testsuite für Konfiguration/Assistent
npm run check # doctor + build, also das, was CI tut
Ruby 3.4 wird benötigt (.ruby-version); das macOS-System-Ruby 2.6 kann diese Website nicht bauen. bin/serve und bin/build erzwingen die richtige Toolchain im PATH.