ai folio
1.0.0
Ein einfaches, sauberes und ansprechendes Jekyll-Theme für Akademiker. Wenn Ihnen das Thema gefällt, geben Sie ihm einen Stern!
Möchten Sie mehr über Jekyll erfahren? Schauen Sie sich dieses Tutorial an. Warum Jekyll? Lesen Sie den Blogbeitrag von Andrej Karpathy!
Für eine praktische Anleitung zur Al-Folio-Installation schauen Sie sich dieses coole Video-Tutorial von einem der Community-Mitglieder an! ? ?
Die bevorzugte Art, diese Vorlage zu verwenden, besteht darin, über der Dateiliste auf „Diese Vorlage verwenden“ zu klicken. Erstellen Sie dann ein neues Repository unter github.com:<your-username>/<your-repo-name> . Wenn Sie planen, Ihre Website auf <your-github-username>.github.io hochzuladen, beachten Sie, dass der Name Ihres Repositorys <your-github-username>.github.io oder <your-github-orgname>.github.io sein muss <your-github-orgname>.github.io , wie in den GitHub-Seitendokumenten angegeben. Weitere Informationen zur Bereitstellung Ihrer Site finden Sie im Abschnitt „Bereitstellung“ weiter unten. Nachdem Sie Ihr neues Repository erstellt haben, laden Sie es einfach auf Ihren Computer herunter:
$ git clone [email protected]: < your-username > / < your-repo-name > .git
$ cd < your-repo-name > Die Verwendung von Docker zur Installation von Jekyll- und Ruby-Abhängigkeiten ist der einfachste Weg.
Sie müssen die folgenden Schritte ausführen, um al-folio auf Ihrem lokalen Computer zum Laufen zu bringen:
$ docker compose pull
$ docker compose upBeachten Sie, dass bei der ersten Ausführung ein Docker-Image mit einer Größe von etwa 400 MB heruntergeladen wird.
Jetzt können Sie das Thema ganz nach Ihren Wünschen anpassen (vergessen Sie nicht, den Namen zu ändern!). Nachdem Sie fertig sind, können Sie denselben Befehl ( docker compose up ) verwenden, um die Webseite mit allen von Ihnen vorgenommenen Änderungen zu rendern. Stellen Sie außerdem sicher, dass Sie Ihre letzten Änderungen festschreiben.
Um die Portnummer zu ändern, können Sie die Datei
docker-compose.ymlbearbeiten.
Hinweis: Dieser Ansatz ist nur erforderlich, wenn Sie eine ältere oder sehr benutzerdefinierte Version von al-folio erstellen möchten.
Erstellen Sie ein neues Docker-Image und führen Sie es aus mit:
$ docker compose up --buildWenn Sie Jekyll aktualisieren, neue Ruby-Pakete installieren usw. möchten, müssen Sie das Image lediglich erneut erstellen, indem Sie das Argument
--force-recreateam Ende des vorherigen Befehls verwenden! Es lädt Ruby und Jekyll herunter und installiert alle Ruby-Pakete erneut von Grund auf.
Wenn Sie eine bestimmte Docker-Version verwenden möchten, können Sie dies tun, indem Sie latest -Tag in docker-compose.yaml in your_version ändern. Beispielsweise haben Sie möglicherweise Ihre Website auf v0.10.0 erstellt und möchten dabei bleiben.
Angenommen, Sie haben Ruby und Bundler auf Ihrem System installiert ( Hinweis: Zur einfacheren Verwaltung von Ruby-Gems sollten Sie die Verwendung von rbenv in Betracht ziehen ) sowie Python und pip ( Hinweis: Zur Vereinfachung der Verwaltung von Python-Paketen sollten Sie die Verwendung einer virtuellen Umgebung wie venv oder conda in Betracht ziehen . Wenn Sie nur jupyter verwenden, können Sie pipx verwenden .
$ bundle install
# assuming pip is your Python package manager
$ pip install jupyter
$ bundle exec jekyll serve --lsiJetzt können Sie das Thema ganz nach Ihren Wünschen anpassen (vergessen Sie nicht, den Namen zu ändern!). Wenn Sie fertig sind, übernehmen Sie Ihre letzten Änderungen.
Die Bereitstellung Ihrer Website auf GitHub Pages ist die beliebteste Option. Ab Version v0.3.5 stellt al-folio Ihre Webseite jedes Mal automatisch neu bereit, wenn Sie neue Änderungen an Ihr Repository übertragen!
Für persönliche und Organisationswebseiten:
<your-github-username>.github.io oder <your-github-orgname>.github.io sein ._config.yml url auf https://<your-github-username>.github.io fest und lassen Sie baseurl leer.<your-github-username>.github.io verfügbar.Für Projektseiten:
_config.yml url auf https://<your-github-username>.github.io und baseurl auf /<your-repository-name>/ fest.<your-github-username>.github.io/<your-repository-name>/ verfügbar.So aktivieren Sie die automatische Bereitstellung:
master -Zweig über einen neu erstellten gh-pages -Zweig verfügen.gh-pages ein ( NICHT auf master ). Weitere Einzelheiten finden Sie unter Konfigurieren einer Veröffentlichungsquelle für Ihre GitHub Pages-Site. Wenn Sie Ihre Website in einem anderen Zweig behalten, öffnen Sie .github/workflows/deploy.yml in dem Zweig, in dem Sie Ihre Website behalten, und ändern Sie on->push->branches und on->pull_request->branches in den Zweig, in dem Sie Ihre Website behalten An. Dadurch wird die Aktion bei Pulls/Pushs auf diesem Zweig ausgelöst. Die Aktion stellt dann die Website in dem Zweig bereit, von dem aus sie ausgelöst wurde.
Wenn Sie Ihre Website manuell erneut auf GitHub-Seiten bereitstellen müssen, gehen Sie zu „Aktionen“, klicken Sie in der linken Seitenleiste auf „Bereitstellen“ und dann auf „Workflow ausführen“.
Wenn Sie GitHub Pages nicht verwenden und Ihre Seite woanders hosten möchten, führen Sie einfach Folgendes aus:
$ bundle exec jekyll build --lsi Dadurch wird die statische Webseite im Ordner _site/ (neu) generiert. Kopieren Sie dann einfach den Inhalt des Verzeichnisses _site/ auf Ihren Hosting-Server.
Wenn Sie auch nicht verwendete CSS-Klassen aus Ihrer Datei entfernen möchten, führen Sie Folgendes aus:
$ purgecss -c purgecss.config.js Dadurch werden die CSS-Dateien im Ordner _site/assets/css/ durch die gelöschten CSS-Dateien ersetzt.
Hinweis: Stellen Sie sicher, dass Sie die url und baseurl Felder in _config.yml korrekt festlegen, bevor Sie die Webseite erstellen. Wenn Sie Ihre Webseite unter your-domain.com/your-project/ bereitstellen, müssen Sie url: your-domain.com und baseurl: /your-project/ festlegen. Wenn Sie die Bereitstellung direkt auf your-domain.com durchführen, lassen Sie baseurl leer.
Hinweis: Versuchen Sie diese Methode nicht, es sei denn, Sie wissen, was Sie tun (stellen Sie sicher, dass Sie mit Veröffentlichungsquellen vertraut sind). Dieser Ansatz ermöglicht es, den Quellcode der Website in einem Repository und die Bereitstellungsversion in einem anderen Repository zu speichern.
Nehmen wir an, dass die Veröffentlichungsquelle Ihrer Website ein Unterverzeichnis publishing-source eines git-versionierten Repositorys ist, das unter $HOME/repo/ geklont wurde. Für eine Benutzerseite könnte dies durchaus etwa $HOME/<user>.github.io sein.
Schauen Sie sich zunächst im Deployment-Repo-Verzeichnis den Git-Zweig an, der Ihre Veröffentlichungsquelle hostet.
Dann aus dem Quellverzeichnis der Website (üblicherweise der Klon Ihres Al-Folio-Forks):
$ bundle exec jekyll build --lsi --destination $HOME /repo/publishing-source Dadurch wird Jekyll angewiesen, die Website unter $HOME/repo/publishing-source bereitzustellen.
Hinweis: Jekyll bereinigt $HOME/repo/publishing-source vor dem Erstellen!
Das folgende Zitat stammt direkt aus den Jekyll-Konfigurationsdokumenten:
Zielordner werden bei Site-Builds bereinigt
Der Inhalt von
<destination>wird standardmäßig automatisch bereinigt, wenn die Site erstellt wird. Dateien oder Ordner, die nicht von Ihrer Site erstellt wurden, werden entfernt. Einige Dateien könnten beibehalten werden, indem sie in der Konfigurationsanweisung<keep_files>angegeben werden.Verwenden Sie keinen wichtigen Ort für
<destination>; Verwenden Sie es stattdessen als Staging-Bereich und kopieren Sie Dateien von dort auf Ihren Webserver.
Wenn $HOME/repo/publishing-source Dateien enthält, die Jekyll unberührt lassen soll, geben Sie sie unter keep_files in _config.yml an. In seiner Standardkonfiguration kopiert al-folio die README.md der obersten Ebene in die Veröffentlichungsquelle. Wenn Sie dieses Verhalten ändern möchten, fügen Sie README.md unter exclude in _config.yml hinzu.
Hinweis: Führen Sie jekyll clean nicht auf Ihrem Veröffentlichungsquell-Repo aus, da dies dazu führt, dass das gesamte Verzeichnis gelöscht wird, unabhängig vom Inhalt von keep_files in _config.yml .
Wenn Sie al-folio wie oben beschrieben installiert haben, können Sie eine GitHub-Aktion konfigurieren, um Ihr Repository automatisch mit der neuesten Version des Themes zu synchronisieren.
Gehen Sie zu Einstellungen -> Aktionen -> Allgemein -> Workflow-Berechtigungen, erteilen Sie GitHub-Aktionen Lese- und Schreibberechtigungen, aktivieren Sie „GitHub-Aktionen erlauben, Pull-Anfragen zu erstellen und zu genehmigen“ und speichern Sie Ihre Änderungen.
Gehen Sie dann zu Aktionen -> Neuer Workflow -> richten Sie selbst einen Workflow ein, richten Sie den folgenden Workflow ein und übernehmen Sie Ihre Änderungen:
name : Sync from template
on :
# cronjob trigger
schedule :
- cron : " 0 0 1 * * "
# manual trigger
workflow_dispatch :
jobs :
repo-sync :
runs-on : ubuntu-latest
steps :
# To use this repository's private action, you must check out the repository
- name : Checkout
uses : actions/checkout@v3
- name : actions-template-sync
uses : AndreasAugustin/[email protected]
with :
github_token : ${{ secrets.GITHUB_TOKEN }}
source_repo_path : alshedivat/al-folio
upstream_branch : masterSie erhalten eine Pull-Anfrage in Ihrem Repository, wenn in der Vorlage einige Änderungen verfügbar sind.
Eine andere Möglichkeit besteht darin, Ihren Code manuell zu aktualisieren, indem Sie die folgenden Schritte ausführen:
# Assuming the current directory is <your-repo-name>
$ git remote add upstream https://github.com/alshedivat/al-folio.git
$ git fetch upstream
$ git rebase v0.9.0 Wenn Sie eine frühere Version umfassend angepasst haben, kann ein Upgrade schwieriger sein. Sie können weiterhin die oben genannten Schritte ausführen, aber git rebase kann zu Zusammenführungskonflikten führen, die gelöst werden müssen. Weitere Informationen finden Sie im Git-Rebase-Handbuch und zur Lösung von Konflikten. Wenn das Rebasing zu kompliziert ist, empfehlen wir, die neue Version des Themes von Grund auf neu zu installieren und Ihre Inhalte und Änderungen gegenüber der vorherigen Version manuell zu portieren.
Hier finden Sie einige häufig gestellte Fragen. Wenn Sie eine andere Frage haben, stellen Sie diese bitte über Diskussionen.
F: Nachdem ich aus dieser Vorlage ein neues Repository erstellt und das Repo eingerichtet habe, erhalte ich einen Bereitstellungsfehler. Soll die Website nicht automatisch korrekt bereitgestellt werden?
A: Ja, wenn Sie Version v0.3.5 oder höher verwenden, wird die Website direkt nach Ihrem ersten Commit automatisch und korrekt erneut bereitgestellt. Bitte nehmen Sie einige Änderungen vor (z. B. ändern Sie Ihre Website-Informationen in _config.yml ), übernehmen Sie den Commit und führen Sie einen Push durch. Befolgen Sie unbedingt die Bereitstellungsanweisungen im vorherigen Abschnitt. (Relevante Ausgabe: 209.)
F: Ich verwende eine benutzerdefinierte Domain (z. B. foo.com ). Meine benutzerdefinierte Domäne wird nach jeder Bereitstellung in den Repository-Einstellungen leer. Wie kann ich das beheben?
A: Sie müssen CNAME Datei zum master oder source Ihres Repositorys hinzufügen. Die Datei sollte Ihren benutzerdefinierten Domänennamen enthalten. (Relevante Ausgabe: 130.)
F: Meine Webseite funktioniert lokal. Nach der Bereitstellung schlägt die Erstellung jedoch fehl und es wird Unknown tag 'toc' ausgegeben. Wie kann ich das beheben?
A: Stellen Sie sicher, dass Sie die Bereitstellungsanweisungen im vorherigen Abschnitt befolgt haben. Sie sollten den Bereitstellungszweig auf gh-pages gesetzt haben. (Verwandte Ausgabe: 1438.)
F: Meine Webseite funktioniert lokal. Aber nach der Bereitstellung wird es nicht richtig angezeigt (CSS und JS werden nicht richtig geladen). Wie kann ich das beheben?
A: Stellen Sie sicher, dass Sie die url und baseurl -Pfade in _config.yml korrekt angeben. Legen Sie url auf https://<your-github-username>.github.io oder auf https://<your.custom.domain> fest, wenn Sie eine benutzerdefinierte Domäne verwenden. Wenn Sie eine persönliche Website oder eine Organisationswebsite bereitstellen, lassen Sie baseurl leer. Wenn Sie eine Projektseite bereitstellen, legen Sie baseurl: /<your-project-name>/ . Wenn alle vorherigen Schritte korrekt ausgeführt wurden, fehlt nur noch, dass Ihr Browser das Site-Stylesheet erneut abruft.
F: Atom-Feed funktioniert nicht. Warum?
A: Stellen Sie sicher, dass Sie die url und baseurl -Pfade in _config.yml korrekt angeben. Das RSS-Feed-Plugin funktioniert mit diesen korrekt eingerichteten Feldern: title , url , description und author . Stellen Sie sicher, dass Sie sie ordnungsgemäß ausfüllen, und versuchen Sie es erneut.
F: Meine Website funktioniert nicht, wenn ich related_blog_posts aktiviere. Warum?
A: Dies liegt wahrscheinlich am Classifier-Reborn-Plugin, das zur Berechnung verwandter Beiträge verwendet wird. Wenn der Fehler Liquid Exception: Zero vectors can not be normalized... lautet, bedeutet dies, dass die zugehörigen Beiträge für einen bestimmten Beitrag nicht berechnet werden konnten. Dies wird normalerweise durch leere oder minimale Blogbeiträge ohne aussagekräftige Wörter (z. B. nur Stoppwörter) oder sogar durch bestimmte Zeichen, die Sie in Ihren Beiträgen verwendet haben, verursacht. Außerdem wird die Berechnung für ähnliche Beiträge für jeden post durchgeführt, d. h. für jede Seite, die layout: post verwendet, einschließlich der Ankündigungen. Um dieses Verhalten zu ändern, fügen Sie einfach related_posts: false zur Titelseite der Seite hinzu, auf der Sie keine verwandten Beiträge anzeigen möchten.
F: Beim Versuch der Bereitstellung werden Github-Anmeldeinformationen abgefragt, woraufhin Github die Kennwortauthentifizierung deaktiviert hat und mit einem Fehler beendet wird. Wie beheben?
A: Öffnen Sie die Datei .git/config mit Ihrem bevorzugten Editor. Ändern Sie den https Teil der url Variablen in ssh . Versuchen Sie es erneut mit der Bereitstellung.
Die Seite Ihrer Veröffentlichungen wird automatisch aus Ihrer BibTex-Bibliographie generiert. Bearbeiten Sie einfach _bibliography/papers.bib . Sie können auch neue *.bib Dateien hinzufügen und das Aussehen Ihrer Veröffentlichungen nach Ihren Wünschen anpassen, indem Sie _pages/publications.md bearbeiten.
In Veröffentlichungen wird der Autoreintrag für Sie selbst durch das String-Array scholar:last_name und das String-Array scholar:first_name in _config.yml identifiziert:
scholar :
last_name : [Einstein]
first_name : [Albert, A.] Wenn der Eintrag mit einer Form des Nachnamens und des Vornamens übereinstimmt, wird er unterstrichen. Speichern Sie Metainformationen über Ihre Co-Autoren in _data/coauthors.yml und Jekyll fügt automatisch Links zu deren Webseiten ein. Das Co-Autoren-Datenformat in _data/coauthors.yml lautet wie folgt:
" Adams " :
- firstname : ["Edwin", "E.", "E. P.", "Edwin Plimpton"]
url : https://en.wikipedia.org/wiki/Edwin_Plimpton_Adams
" Podolsky " :
- firstname : ["Boris", "B.", "B. Y.", "Boris Yakovlevich"]
url : https://en.wikipedia.org/wiki/Boris_Podolsky
" Rosen " :
- firstname : ["Nathan", "N."]
url : https://en.wikipedia.org/wiki/Nathan_Rosen
" Bach " :
- firstname : ["Johann Sebastian", "J. S."]
url : https://en.wikipedia.org/wiki/Johann_Sebastian_Bach
- firstname : ["Carl Philipp Emanuel", "C. P. E."]
url : https://en.wikipedia.org/wiki/Carl_Philipp_Emanuel_BachWenn der Eintrag mit einer der Kombinationen aus Nachnamen und Vornamen übereinstimmt, wird er hervorgehoben und mit der angegebenen URL verknüpft.
Es gibt mehrere benutzerdefinierte Bibtex-Schlüsselwörter, mit denen Sie beeinflussen können, wie die Einträge auf der Webseite angezeigt werden:
abbr : Fügt links vom Eintrag eine Abkürzung hinzu. Sie können Links zu diesen hinzufügen, indem Sie eine Venue.yaml-Datei im Ordner „_data“ erstellen und entsprechende Einträge hinzufügen.abstract : Fügt eine „Abs“-Schaltfläche hinzu, die beim Klicken ein ausgeblendetes Textfeld erweitert, um den abstrakten Text anzuzeigenarxiv : Fügt einen Link zur Arxiv-Website hinzu (Hinweis: Fügen Sie hier nur die arxiv-Kennung hinzu – der Link wird automatisch generiert.)bibtex_show : Fügt eine „Bib“-Schaltfläche hinzu, die ein ausgeblendetes Textfeld mit dem vollständigen Bibliographieeintrag erweiterthtml : Fügt eine „HTML“-Schaltfläche ein, die zum vom Benutzer angegebenen Link weiterleitetpdf : Fügt eine Schaltfläche „PDF“ hinzu, die zu einer angegebenen Datei weiterleitet (wenn kein vollständiger Link angegeben ist, wird davon ausgegangen, dass die Datei im Verzeichnis /assets/pdf/ abgelegt ist).supp : Fügt einer angegebenen Datei eine Schaltfläche „Supp“ hinzu (wenn kein vollständiger Link angegeben ist, wird davon ausgegangen, dass die Datei im Verzeichnis /assets/pdf/ abgelegt ist).blog : Fügt eine „Blog“-Schaltfläche hinzu, die zum angegebenen Link weiterleitetcode : Fügt eine „Code“-Schaltfläche hinzu, die zum angegebenen Link weiterleitetposter : Fügt eine „Poster“-Schaltfläche hinzu, die zu einer angegebenen Datei weiterleitet (wenn kein vollständiger Link angegeben ist, wird davon ausgegangen, dass die Datei im Verzeichnis /assets/pdf/ abgelegt ist).slides : Fügt eine Schaltfläche „Folien“ hinzu, die zu einer angegebenen Datei weiterleitet (wenn kein vollständiger Link angegeben ist, wird davon ausgegangen, dass die Datei im Verzeichnis /assets/pdf/ abgelegt ist).website : Fügt eine Schaltfläche „Website“ hinzu, die zum angegebenen Link weiterleitetaltmetric : Fügt ein Altmetric-Badge hinzu (Hinweis: Wenn DOI angegeben wird, verwenden Sie einfach true , andernfalls fügen Sie hier nur die Altmetric-Kennung hinzu – der Link wird automatisch generiert)dimensions : Fügt ein Dimensions-Badge hinzu (Hinweis: Wenn DOI oder PMID angegeben wird, verwenden Sie einfach true , andernfalls fügen Sie hier nur die Dimensions-ID hinzu – der Link wird automatisch generiert.)Sie können Ihre eigenen Schaltflächen implementieren, indem Sie die Datei bib.html bearbeiten.
Dieses Jekyll-Theme implementiert collections , damit Sie Ihre Arbeit in Kategorien unterteilen können. Das Thema enthält zwei Standardsammlungen: news und projects . Artikel aus der news werden automatisch auf der Startseite angezeigt. Elemente aus der projects werden in einem responsiven Raster auf der Projektseite angezeigt.
Sie können ganz einfach Ihre eigenen Sammlungen, Apps, Kurzgeschichten, Kurse oder was auch immer Ihre kreative Arbeit ist, erstellen. Bearbeiten Sie dazu die Sammlungen in der Datei _config.yml , erstellen Sie einen entsprechenden Ordner und erstellen Sie eine Landingpage für Ihre Sammlung, ähnlich wie _pages/projects.md .
al-folio bietet stilvolle Layouts für Seiten und Blogbeiträge.
Mit dem Theme können Sie Blogbeiträge im „destill.pub“-Stil erstellen:
Weitere Einzelheiten zum Erstellen von Beiträgen im Destillierstil mithilfe von <d-*> Tags finden Sie im Beispiel.
al-folio unterstützt den schnellen mathematischen Schriftsatz durch MathJax und die Hervorhebung der Codesyntax mithilfe des GitHub-Stils:
Die Fotoformatierung wird mithilfe des Rastersystems von Bootstrap vereinfacht. Erstellen Sie ganz einfach schöne Raster in Ihren Blogbeiträgen und Projektseiten:
al-folio verwendet github-readme-stats und github-profile-trophy, um GitHub-Repositories und Benutzerstatistiken auf der Seite /repositories/ anzuzeigen.
Bearbeiten Sie die _data/repositories.yml und ändern Sie die Listen github_users und github_repos um Ihr eigenes GitHub-Profil und Ihre eigenen Repositorys in die Seite /repositories/ aufzunehmen.
Sie können die folgenden Codes auch verwenden, um dies auf anderen Seiten anzuzeigen.
<!-- code for GitHub users -->
{% if site.data.repositories.github_users %}
< div class =" repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center " >
{% for user in site.data.repositories.github_users %}
{% include repository/repo_user.html username=user %}
{% endfor %}
</ div >
{% endif %}
<!-- code for GitHub trophies -->
{% if site.repo_trophies.enabled %}
{% for user in site.data.repositories.github_users %}
{% if site.data.repositories.github_users.size > 1 %}
< h4 > {{ user }} </ h4 >
{% endif %}
< div class =" repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center " >
{% include repository/repo_trophies.html username=user %}
</ div >
{% endfor %}
{% endif %}
<!-- code for GitHub repositories -->
{% if site.data.repositories.github_repos %}
< div class =" repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center " >
{% for repo in site.data.repositories.github_repos %}
{% include repository/repo.html repository=repo %}
{% endfor %}
</ div >
{% endif %} Es wurde eine Vielzahl wunderschöner Themenfarben ausgewählt, aus denen Sie wählen können. Die Standardeinstellung ist Lila, aber Sie können sie schnell ändern, indem Sie die Variable --global-theme-color in der Datei _sass/_themes.scss bearbeiten. Dort sind auch andere Farbvariablen aufgeführt. Die verfügbaren Standard-Theme-Farboptionen finden Sie unter _sass/_variables.scss . Sie können dieser Datei auch Ihre eigenen Farben hinzufügen und jeder Farbe einen Namen zuweisen, um die Verwendung in der gesamten Vorlage zu vereinfachen.
al-folio unterstützt Vorschaubilder in sozialen Medien. Um diese Funktionalität zu aktivieren, müssen Sie serve_og_meta in Ihrer _config.yml auf true setzen. Sobald Sie dies getan haben, enthalten alle Seiten Ihrer Website Open Graph-Daten im HTML-Kopfelement.
Anschließend müssen Sie konfigurieren, welches Bild in den Social-Media-Vorschauen Ihrer Website angezeigt werden soll. Dies kann auf Seitenbasis konfiguriert werden, indem die Seitenvariable og_image festgelegt wird. Wenn diese Variable für eine einzelne Seite nicht festgelegt ist, greift das Design auf eine Site-weite og_image Variable zurück, die in Ihrer _config.yml konfigurierbar ist. Sowohl im seitenspezifischen als auch im Site-weiten Fall muss die Variable og_image die URL für das Bild enthalten, das Sie in den Social-Media-Vorschauen anzeigen möchten.
Es generiert einen Atom-Feed (RSS-ähnlich) Ihrer Beiträge, der für Atom- und RSS-Reader nützlich ist. Sie können den Feed erreichen, indem Sie einfach nach Ihrer Homepage /feed.xml eingeben. Wenn Sie beispielsweise davon ausgehen, dass Ihr Website-Mountpoint der Hauptordner ist, können Sie yourusername.github.io/feed.xml eingeben
Standardmäßig gibt es unten in den Blogbeiträgen einen Abschnitt mit verwandten Beiträgen. Diese werden generiert, indem die max_related neuesten Beiträge ausgewählt werden, die mindestens min_common_tags -Tags mit dem aktuellen Beitrag teilen. Wenn Sie zu einem bestimmten Beitrag keine verwandten Beiträge anzeigen möchten, fügen Sie einfach related_posts: false zur Titelseite des Beitrags hinzu. Wenn Sie es für alle Beiträge deaktivieren möchten, setzen Sie einfach im Abschnitt related_blog_posts in _config.yml „ enabled “ auf „false“.
Beiträge zu al-folio sind herzlich willkommen! Bevor Sie beginnen, werfen Sie bitte einen Blick auf die Richtlinien.
Wenn Sie die Dokumentation verbessern, Ihre Webseite zur Liste unten hinzufügen oder eine kleinere Inkonsistenz oder einen Fehler beheben möchten, können Sie gerne eine PR direkt an master senden. Bei komplexeren Problemen/Fehlern oder Funktionswünschen öffnen Sie bitte ein Problem mit der entsprechenden Vorlage.
Unsere aktivsten Mitwirkenden sind herzlich willkommen, dem Betreuerteam beizutreten. Bei Interesse melden Sie sich bitte!
Maruan | Rohan Deb Sarkar | Amir Pourmand | Georg |
Hergestellt mit contrib.rocks.
Das Thema ist als Open Source unter den Bedingungen der MIT-Lizenz verfügbar.
Ursprünglich basierte al-folio auf dem *folio-Thema (veröffentlicht von Lia Bogoev und unter der MIT-Lizenz). Seitdem wurden die Stile komplett neu geschrieben und viele zusätzliche coole Funktionen hinzugefügt.
