jake

Jake adalah alat yang memungkinkan Anda untuk membuat situs web satu-link Anda dengan mudah dan menggunakannya di akun GitHub Anda.

Demo

Penggunaan

1. Buat repositori

Untuk memulai, ikuti langkah -langkah ini untuk membuat repositori baru menggunakan template ini:

1. Klik di sini untuk membuat repositori baru.
2. Pilih nama untuk repositori Anda. Jika Anda ingin situs web Anda digunakan di <yourusername>.github.io , beri nama repositori Anda <yourusername>.github.io . Sebagai alternatif, Anda dapat memilih nama lain, seperti that-other-name , yang akan mengakibatkan situs web Anda digunakan di <yourusername>.github.io/that-other-name/ .

2. Aktifkan halaman GitHub

Setelah membuat repositori, Anda perlu mengaktifkan halaman GitHub. Ikuti langkah -langkah ini:

1. Buka tab Settings Repositori Anda.
2. Arahkan ke bagian Pages .
3. Pilih GitHub Actions sebagai sumber untuk halaman GitHub Anda.
4. Klik Save untuk menerapkan perubahan.

3. Tambahkan data Anda

Untuk menyesuaikan situs web Anda, ikuti langkah -langkah ini:

1. Buka repositori Anda di editor teks pilihan Anda.
2. Temukan file data.toml dan perbarui dengan informasi Anda.

Klik untuk mempelajari semua pengaturan yang tersedia di sini

Informasi umum

• name : Nama Anda (mis. "Vahid AL")
• description : Bio singkat tentang diri Anda (misalnya, "pengembang perangkat lunak dan bersemangat menciptakan sesuatu")
• keywords : Kata kunci untuk tag meta kata kunci (misalnya, "python, javascript, go")
• image : Alamat file avatar Anda. Tempatkan avatar Anda di dalam folder dist/img/ (misalnya, "Me.jpeg" - Perhatikan bahwa /dist/img/ alamat IMG tidak termasuk)
• theme : Pilih Tema Situs Web Anda: "Gelap" atau "terang" (misalnya, "gelap")
• primary_color : Tentukan warna utama situs web Anda menggunakan kode warna heksadesimal (misalnya, "#00897b")
• text_align : Tentukan perataan teks untuk situs web Anda: "kanan", "kiri" atau "tengah" (misalnya "tengah")
• gtag_id : ID Pelacakan Analisis Google Anda (misalnya, "G-33WB8LVHR6")
• base_url : URL dasar untuk situs web Anda, disebutkan dalam 1. Buat langkah repositori (misalnya, https://thevahidal.github.io/jake)

Bagian

Anda dapat menambahkan beberapa bagian berdasarkan kebutuhan Anda. Misalnya, Anda mungkin menginginkan bagian untuk proyek Anda, yang lain untuk tautan media sosial Anda, dan lainnya untuk produk barang dagangan Anda.

Setiap bagian didefinisikan menggunakan [[sections]] dan memiliki komponen berikut:

• title : Judul bagian (misalnya, "Proyek")
• description : Deskripsi singkat dari bagian ini (misalnya, "Berikut adalah beberapa proyek saya")
• direction : arah bagian: "baris" atau "kolom" (misalnya, "baris")
• item_style : Gaya item di bagian: "garis besar" atau "diisi" (misalnya, "garis besar")
• items : Item yang terkait dengan bagian ini.

Item

Setiap item didefinisikan menggunakan [[sections.items]] dan memiliki komponen berikut:

• title : Judul item (misalnya, "Soul")
• description : Deskripsi singkat item (misalnya, "server sqlite istirahat dan waktu nyata")
• url : URL yang terkait dengan item (misalnya, "https://github.com/thevahidal/soul")

4. Voila

Hanya itu yang perlu Anda lakukan. Sekarang, Anda dapat duduk dan bersantai saat situs web Anda dikerahkan. Anda dapat memantau kemajuan dalam tab Actions Repositori Anda. Setelah penyebaran selesai, Anda dapat mengakses situs web satu-link baru Anda di <yourusername>.github.io (jika Anda memilih <yourusername>.github.io sebagai nama repositori Anda) atau <yourusername>.github.io/repo-name/ .

FAQ

1. Bagaimana cara mengkonfigurasi domain khusus saya sendiri?

Jika Anda ingin menggunakan domain khusus Anda untuk situs web Anda yang di -host di halaman GitHub, ini adalah proses yang mudah. Ikuti saja langkah -langkah ini:

1. Buka tab Pengaturan dari repositori GitHub Anda.
2. Pilih tab Halaman di bilah samping.
3. Di bawah bagian Domain Kustom , masukkan nama domain yang Anda inginkan.
4. Klik Simpan .

Itu saja! Situs halaman GitHub Anda sekarang dapat diakses menggunakan domain khusus Anda.

Untuk instruksi dan informasi yang lebih terperinci tentang penggunaan domain khusus dengan halaman GitHub, Anda dapat merujuk ke dokumen resmi GitHub.

2. Bagaimana cara memicu tindakan github secara manual untuk menggunakan situs web saya?

1. Di repositori Anda, navigasikan ke tab "Tindakan".
2. Cari alur kerja bernama "Deploy Jake Situs web ke Github Pages" dalam daftar alur kerja.
3. Jika Anda melihat peringatan yang menyatakan "Alur kerja ini memiliki pemicu acara workflow_dispatch," itu berarti Anda dapat memicu alur kerja secara manual.
4. Klik tombol "Jalankan Alur Kerja". Jendela baru akan muncul.
5. Di dalam jendela baru, klik tombol Green "Run Workflow".
6. Tindakan GitHub akan memulai proses penyebaran untuk konten statis Anda ke halaman GitHub.

Berkontribusi

Jika Anda menemukan masalah atau memiliki saran untuk perbaikan, jangan ragu untuk berkontribusi dengan mengirimkan permintaan tarik atau membuat masalah di repositori.

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT.