simplest jekyll -Download - simplest jekyll Source Code Download

simplest jekyll

Andere Kategorien

v1.1.0

Herunterladen

Einfachste Jekyll

Eine minimale Jekyll-basierte Website auf GH-Seiten, die auf eine Inhaltsseite mit einem Thema reduziert wird

Vorschau

Um

Dies ist eine Vorlage und ein Live -Demo -Projekt. Es zeigt, wie wenig Sie einrichten müssen, um eine Jekyll -Site auf GH -Seiten zu erhalten.

Index.md
- Für die Homepage - die einzige Seite in diesem Fall.
- Wenn Sie diese Seite auslassen, wird README.md als Homepage verwendet.
_config.yml
- Setzen Sie das Thema - das layout und styling.
- Aktivieren Sie das Jekyll Sitemap -Plugin - Aktivieren Sie es in GemFile nicht aus. Beachten Sie, dass andere Plugins für Sie wie optional Frontmatter aktiviert werden.
- Andere Standardwerte wie baseurl , title und description wurden aus der Konfiguration ausgeschlossen. Beim Aufbau auf GH -Seiten werden diese durch das GEM -Juwel für Sie für Sie abgeleitet.
GemFile
- Dies wird nicht von GH -Seiten verwendet, ermöglicht es Ihnen jedoch, das Jekyll -Thema lokal mit Bundler zu installieren.
- Verwenden Sie ein einzelnes Gem- github-pages wenn Sie alle Edelsteine auf GH-Seiten übereinstimmen möchten (die schwer zu installieren können).
- Löschen Sie diese Datei, wenn Sie Ihre Website nicht lokal ausführen müssen.

Wenn Sie ein umfassenderes Beispiel für eine mehrseitige Site mit Posts, Edelsteinen, Layouts usw. wünschen, lesen Sie mein Jekyll-Blog-Demo-Repo. Das kann auch als Vorlage und Demo -Site verwendet werden.

So verwenden Sie dieses Projekt

Aufstellen

Klicken Sie auf diese Vorlage, um ein neues Repo in Ihrem eigenen Konto zu erstellen. Sie können den Namen als simplest-jekyll hinterlassen.
Aktivieren Sie GitHub -Seiten in den Einstellungen Ihres Repos. Entscheiden Sie sich, bei master Zweig und der Option / Path zu dienen.
Überprüfen Sie die Registerkarte Ihres Repos, um zu sehen, wann die Bereitstellung durchgeführt wird.
Klicken Sie auf die Bereitstellung anzeigen, um die Live -Site anzuzeigen. EG https://michaelcurrin.github.io/simplest-jekyll/

Beachten Sie, dass /simplest-jekyll/index.html sofort verfügbar ist, es dauert jedoch einige Minuten, bis Github-Seiten /simplest-jekyll/ verfügbar sind.

Anpassen

Aktualisieren Sie die README.md mit Ihren eigenen Details. Dies wird nicht in der bereitgestellten Website verwendet, sondern lokal und auf GitHub sichtbar.
Themen
- Bearbeiten Sie das Thema in _config.yml, wenn Sie ein anderes Thema möchten.
- Sie können auch den Abschnitt GitHub -Seiten der Repo -Einstellungen verwenden, um visuell vorschau zu sein.
- Beachten Sie nur, dass nur Themen, die von GitHub -Seiten unterstützt werden, abgedeckt werden (ca. 10). Wenn Sie jedoch das Feld remote_theme in Ihrer Konfiguration verwenden, können Sie weitere Themen verweisen.
- Für die Installation und Ausführung lokal müssen Sie sicherstellen, dass Ihre GemFile das in der Konfiguration verwendete Thema abdeckt.
Wie bei den meisten Jekyll -Websites wird der Index.md als Homepage verwendet.
- Es hat oben vordere Materie, so dass jede Flüssigkeit aufgetragen wird.
- Bearbeiten Sie Ihre index.md -Datei mit Ihrem eigenen Inhalt als HTML oder Markdown.
- Sie können es in index.html umbenennen, wenn Sie nur eine einfache HTML wünschen.
- Sie können die vordere Materie oben entfernen, um die Flüssigkeitsformatierung und alle Themen zu entfernen.
Wenn Sie möchten, fügen Sie mehr Seiten am Wurzel hinzu und teilen Sie alle gängigen HTML wie Header oder Kopf oder Navigationsantrieb in den Ordner _includes oder _layouts -Ordner aus (sind auch im Geltungsbereich dieses Projekts behandelt, sondern sind für Jekyllll -Projekte üblich).
Weitere Informationen finden Sie in den Dokumenten und Tutorials auf der Jekyll -Website.
Optional Jekyll lokal ausführen:
- Installieren Sie Ruby und Bundler.
- Installieren Sie Project Gems - Jekyll und das Themenstein.
- Führen Sie den Jekyll Dev Server aus.
- Fuller -Anweisungen finden Sie in den Dokumenten von Jekyll Blog Demo. Sie müssen auch eine Makefile hinzufügen, um diese Befehle zu entsprechen.