jake

Jake ist ein Tool, mit dem Sie Ihre One-Link-Website mühelos erstellen und auf Ihrem Github-Konto bereitstellen können.

Demo

Verwendung

1. Erstellen Sie ein Repository

Befolgen Sie, um mit dieser Vorlage ein neues Repository zu erstellen, um ein neues Repository zu erstellen:

1. Klicken Sie hier, um ein neues Repository zu erstellen.
2. Wählen Sie einen Namen für Ihr Repository. Wenn Sie möchten, dass Ihre Website unter <yourusername>.github.io bereitgestellt wird, nennen Sie Ihr Repository <yourusername>.github.io . Alternativ können Sie einen anderen Namen wie that-other-name auswählen, der dazu führt, dass Ihre Website unter <yourusername>.github.io/that-other-name/ bereitgestellt wird.

2. Aktivieren Sie GitHub -Seiten

Nach dem Erstellen des Repositorys müssen Sie GitHub -Seiten aktivieren. Folgen Sie folgenden Schritten:

1. Gehen Sie zur Registerkarte Ihres Repository Settings .
2. Navigieren Sie zum Abschnitt Pages .
3. Wählen Sie GitHub Actions als Quelle für Ihre Github -Seiten.
4. Klicken Sie auf Save , um die Änderungen anzuwenden.

3. Fügen Sie Ihre Daten hinzu

Um Ihre Website anzupassen, befolgen Sie die folgenden Schritte:

1. Öffnen Sie Ihr Repository in Ihrem bevorzugten Texteditor.
2. Suchen Sie die Datei data.toml und aktualisieren Sie sie mit Ihren Informationen.

Klicken Sie hier, um alle verfügbaren Einstellungen hier zu erfahren

Allgemeine Informationen

• name : Ihr Name (zB "vahid al")
• description : Eine kurze Biografie über sich selbst (z. B. "Softwareentwickler und leidenschaftlich über das Erstellen von Dingen")
• keywords : Schlüsselwörter für das Keywords Meta -Tag (z. B. "Python, JavaScript, Go")
• image : Die Dateiadresse Ihres Avatars. Platzieren Sie Ihren Avatar in den dist/img/ Ordner (z. B. "me.jpeg" - Beachten Sie, dass die /dist/img/ Adresse nicht enthalten ist).
• theme : Wählen Sie Ihr Website -Thema: "Dark" oder "Hell" (z. B. "Dark")
• primary_color : Geben Sie die primäre Farbe Ihrer Website mit einem hexadezimalen Farbcode (z. B. "#00897b" an) an
• text_align : Geben Sie die Textausrichtung für Ihre Website an: "rechts", "links" oder "Zentrum" (z. B. "Center").
• gtag_id : Ihre Google Analytics Tracking-ID (z. B. "G-33WB8LVHR6")
• base_url : Die Basis -URL für Ihre Website, die in 1. Erstellen Sie einen Repository -Schritt (z. B. https://thevahidal.github.io/jake)

Abschnitte

Sie können mehrere Abschnitte basierend auf Ihren Anforderungen hinzufügen. Sie möchten beispielsweise einen Abschnitt für Ihre Projekte, einen anderen für Ihre Social -Media -Links und einen anderen für Ihre Warenprodukte.

Jeder Abschnitt wird mit [[sections]] definiert und hat die folgenden Komponenten:

• title : Der Titel des Abschnitts (z. B. "Projekte")
• description : Eine kurze Beschreibung des Abschnitts (z. B. "Hier sind einige meiner Projekte")
• direction : Die Richtung des Abschnitts: "Zeile" oder "Spalte" (z. B. "Zeile")
• item_style : Der Stil der Elemente im Abschnitt: "Umriss" oder "gefüllt" (z. B. "Umriss")
• items : Die mit dem Abschnitt zugeordneten Elemente.

Artikel

Jedes Element wird mit [[sections.items]] definiert und verfügt über die folgenden Komponenten:

• title : Der Titel des Elements (zB "Soul")
• description : Eine kurze Beschreibung des Elements (z. B. "eine SQLite-Ruhe und Echtzeitserver")
• url : Die mit dem Element zugeordnete URL (z. B. "https://github.com/thevahidal/soul"))

4. Voila

Das ist alles, was Sie tun müssen. Jetzt können Sie sich zurücklehnen und entspannen, während Ihre Website bereitgestellt wird. Sie können den Fortschritt auf der Registerkarte Actions Ihres Repositorys überwachen. Sobald die Bereitstellung abgeschlossen ist, können Sie auf Ihre brandneue One-Link-Website unter <yourusername>.github.io zugreifen (wenn Sie <yourusername>.github.io als Repository-Name gewählt haben) oder <yourusername>.github.io/repo-name/ .

FAQ

1. Wie konfigurieren Sie meine eigene benutzerdefinierte Domäne ?

Wenn Sie Ihre benutzerdefinierte Domain für Ihre Website auf GitHub -Seiten verwenden möchten, ist dies ein einfacher Prozess. Befolgen Sie einfach die folgenden Schritte:

1. Gehen Sie zur Registerkarte "Einstellungen" Ihres Github -Repositorys.
2. Wählen Sie in der Seitenleiste die Registerkarte "Seiten" .
3. Geben Sie im Abschnitt benutzerdefinierter Domain Ihren gewünschten Domänennamen ein.
4. Klicken Sie auf Speichern .

Das war's! Ihre GitHub Pages -Site ist nun mit Ihrer benutzerdefinierten Domain zugegriffen.

Für detailliertere Anweisungen und Informationen zur Verwendung einer benutzerdefinierten Domäne mit GitHub -Seiten können Sie sich auf die offiziellen Github -Dokumente verweisen.

2. Wie kann man die GitHub -Aktion manuell auslösen, um meine Website bereitzustellen?

1. Navigieren Sie in Ihrem Repository zur Registerkarte "Aktionen".
2. Suchen Sie in der Liste der Workflows nach dem Workflow mit dem Namen "JAKE -Website auf Github Pages".
3. Wenn Sie einen Alarm sehen, der besagt, dass "dieser Workflow einen Workflow_Dispatch -Ereignisauslöser hat", können Sie den Workflow manuell auslösen.
4. Klicken Sie auf die Schaltfläche "Workflow ausführen". Ein neues Fenster wird angezeigt.
5. Klicken Sie im neuen Fenster auf die Schaltfläche "Workflow ausführen".
6. GitHub -Aktionen initiieren den Bereitstellungsprozess für Ihren statischen Inhalt in GitHub -Seiten.

Beitragen

Wenn Sie Probleme finden oder Verbesserungsvorschläge haben, können Sie einen Beitrag leisten, indem Sie eine Pull -Anfrage einreichen oder ein Problem im Repository erstellen.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert.