minimal

Das Minimal-Thema

Minimal ist ein Jekyll-Theme für GitHub Pages. Sie können eine Vorschau des Themas anzeigen, um zu sehen, wie es aussieht, oder es sogar noch heute verwenden.

Verwendung

So verwenden Sie das Minimal-Design:

1. Fügen Sie Folgendes zur _config.yml Ihrer Site hinzu:

    remote_theme : pages-themes/[email protected]
   plugins :
   - jekyll-remote-theme # add this line to the plugins list if you already have one

2. Wenn Sie eine Vorschau Ihrer Website auf Ihrem Computer anzeigen möchten, fügen Sie optional Folgendes zur Gemfile Ihrer Website hinzu:

    gem "github-pages" , group : :jekyll_plugins 

Anpassen

Konfigurationsvariablen

Minimal berücksichtigt die folgenden Variablen, sofern sie in _config.yml Ihrer Site festgelegt sind:

 title : [The title of your site]
description : [A short description of your site's purpose]

Darüber hinaus können Sie die folgenden optionalen Variablen festlegen:

 show_downloads : ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics : [Your Google Analytics tracking ID]

Stylesheet

Wenn Sie Ihre eigenen benutzerdefinierten Stile hinzufügen möchten:

1. Erstellen Sie auf Ihrer Site eine Datei mit dem Namen /assets/css/style.scss
2. Fügen Sie am Anfang der Datei den folgenden Inhalt hinzu, genau wie gezeigt:

   ---
   ---
   
   @import " {{ site.theme }} " ;

3. Fügen Sie direkt nach der @import import-Zeile jedes gewünschte benutzerdefinierte CSS (oder Sass, einschließlich Importe) hinzu

Hinweis: Wenn Sie die Sass-Variablen des Themes ändern möchten, müssen Sie neue Werte vor der @import Zeile in Ihrem Stylesheet festlegen.

Layouts

Wenn Sie das HTML-Layout des Themes ändern möchten:

1. Für einige Änderungen, wie zum Beispiel ein benutzerdefiniertes favicon , können Sie benutzerdefinierte Dateien in Ihrem lokalen _includes Ordner hinzufügen. Die mit dem Theme bereitgestellten Dateien dienen als Ausgangspunkt und werden in die ursprüngliche Layoutvorlage eingebunden.
2. Für umfangreichere Änderungen kopieren Sie die Originalvorlage aus dem Repository des Themes
   ( Profi-Tipp: Klicken Sie auf „raw“, um das Kopieren zu erleichtern .)
3. Erstellen Sie auf Ihrer Site eine Datei mit dem Namen /_layouts/default.html
4. Fügen Sie den im ersten Schritt kopierten Standardlayoutinhalt ein
5. Passen Sie das Layout nach Ihren Wünschen an

Anpassen des Google Analytics-Codes

Google hat im Laufe der Jahre seit der ersten Erstellung dieses Themas mehrere Iterationen seines Google Analytics-Codes veröffentlicht. Wenn Sie den neuesten Code nutzen möchten, fügen Sie ihn in _includes/head-custom-google-analytics.html auf Ihrer Jekyll-Site ein.

Überschreiben von GitHub-generierten URLs

Vorlagen basieren häufig auf von GitHub bereitgestellten URLs, z. B. Links zu Ihrem Repository oder Links zum Herunterladen Ihres Projekts. Wenn Sie eine oder mehrere Standard-URLs überschreiben möchten:

1. Sehen Sie sich die Vorlagenquelle an, um den Namen der Variablen zu ermitteln. Es hat die Form {{ site.github.zip_url }} .
2. Geben Sie die URL an, die die Vorlage im _config.yml Ihrer Website verwenden soll. Wenn die Variable beispielsweise site.github.url wäre, würden Sie Folgendes hinzufügen:

    github :
     zip_url : http://example.com/download.zip
     another_url : another value

3. Wenn Ihre Website erstellt wird, verwendet Jekyll die von Ihnen angegebene URL und nicht die von GitHub bereitgestellte Standard-URL.

Hinweis: Sie müssen die site. Präfix und jeder Variablenname (nach dem github. ) sollte mit zwei Leerzeichen unter github: eingerückt werden.

Weitere Informationen finden Sie in der Dokumentation zu Jekyll-Variablen.

Roadmap

Eine Liste der vorgeschlagenen Funktionen (und bekannten Probleme) finden Sie unter „Offene Probleme“.

Projektphilosophie

Das Minimal-Theme soll es GitHub Pages-Benutzern schnell und einfach machen, ihre erste (oder 100.) Website zu erstellen. Das Thema sollte die Bedürfnisse der überwiegenden Mehrheit der Benutzer sofort erfüllen und eher auf Einfachheit als auf Flexibilität setzen. Außerdem sollte es den Benutzern die Möglichkeit geben, sich für zusätzliche Komplexität zu entscheiden, wenn sie spezifische Anforderungen haben oder ihr Erlebnis weiter anpassen möchten (z. B. das Hinzufügen von benutzerdefiniertem CSS oder das Ändern des Standardlayouts). Es sollte auch toll aussehen, aber das versteht sich von selbst.

Mitwirken

Sind Sie daran interessiert, einen Beitrag zu Minimal zu leisten? Wir würden uns über Ihre Hilfe freuen. Minimal ist ein Open-Source-Projekt, bei dem Benutzer wie Sie einen Beitrag nach dem anderen erstellen. Anweisungen zum Mitwirken finden Sie in der Datei CONTRIBUTING.

Lokale Vorschau des Themes

Wenn Sie das Theme lokal in der Vorschau anzeigen möchten (z. B. während Sie eine Änderung vorschlagen):

1. Klonen Sie das Repository des Themes ( git clone https://github.com/pages-themes/minimal )
2. cd in das Verzeichnis des Themes
3. Führen Sie script/bootstrap aus, um die erforderlichen Abhängigkeiten zu installieren
4. Führen Sie bundle exec jekyll serve aus, um den Vorschauserver zu starten
5. Besuchen Sie localhost:4000 in Ihrem Browser, um eine Vorschau des Themas anzuzeigen

Laufende Tests

Das Theme enthält eine minimale Testsuite, um sicherzustellen, dass eine Site mit dem Theme erfolgreich erstellt werden kann. Um die Tests auszuführen, führen Sie einfach script/cibuild aus. Sie müssen script/bootstrap einmal ausführen, bevor das Testskript funktioniert.