urlzap
v1.0.0
Penyingkat URL statis Anda sendiri ⚡️
Generator situs statis yang dipublikasikan di Halaman Github cukup populer saat ini. Namun bagaimana dengan penyingkat URL statis (belum lagi generator), yang memungkinkan Anda mengalihkan URL berdasarkan file statis?
Biasanya, pengembang akhirnya menyiapkan server dengan pengalihan untuk ini (bukan secara statis). Di sinilah URLZap masuk. Ini menghasilkan URL menggunakan file dan sihir HTML, memungkinkan pengguna untuk meng-host pengalihan URL mereka sendiri ke Halaman Github.
Mirip dengan generator situs web statis, tetapi untuk URL
Simpanlah URL Anda (yang dipersingkat atau tidak).
Dapat digunakan dengan Halaman Github
Tidak perlu menjalankan server atau mengatur pengalihan HTTP 301
Contoh proyek: brunoluiz/_
Anda mungkin bertanya pada diri sendiri: bagaimana hal ini dilakukan tanpa server? Jawabannya ada pada <meta http-equiv="refresh" /> . Ini berfungsi sebagai kode status HTTP 301 (Redirect), tetapi dilakukan di sisi klien. Ada sedikit penjelasan lebih lanjut di situs w3c.
Berdasarkan config.yml yang berisi jalur dan URL yang diinginkan, urlzap akan membuat file index.html yang menggunakan tag meta refresh. Ini tidak sesempurna HTTP 301, tetapi cukup mendekati. Strategi serupa digunakan oleh generator situs web statis lainnya, seperti Hugo.
Contohnya adalah:
path: './links' # defaultnya adalah './'urls: google: https://google.com alat:github: https://github.com
Setiap kunci di peta akan dipetakan ke rute {.path param}/{key} dan dialihkan ke {value} . Ini akan menghasilkan hal berikut:
- links/ - google/ - index.html (contains redirect) - tools/ - github/ - index.html (contains redirect)
File-file ini misalnya dapat diunggah ke Halaman Github, tidak memerlukan server apa pun. Di brunoluiz/_ Anda dapat melihat contoh config.yml dan memeriksa hasilnya di cabang gh-pages
Periksa bagian rilis untuk rincian informasi lebih lanjut
Gunakan brew untuk menginstalnya
brew tap brunoluiz/tap brew install urlzap
Menggunakan contoh YAML sebelumnya:
path: './links' # defaultnya adalah './'urls: google: https://google.com alat:github: https://github.com
urls : peta URL yang diinginkan, mengikuti pola {key}:{redirect URL}
path : jalur keluaran
Untuk menghasilkan file statis, jalankan urlzap generate .
Kemungkinan besar Anda akan menggunakan Halaman Github bersama dengan alat ini. Jika demikian, mungkin cara terbaik untuk menggunakannya dan mendapatkan manfaatnya adalah melalui Github Actions. Kunjungi brunoluiz/urlzap-github-action untuk detail lebih lanjut tentang cara menginstalnya, mencakup pembuatan & penerapan.
️ Anda mungkin perlu mengaktifkan Halaman Github secara manual di repositori Anda! Detail lebih lanjut di panduan Halaman Github
Jika Github Actions bukan untuk Anda, coba proses manual berikut ini.
Aktifkan Halaman Github dan atur cabang tempat file HTML statis Anda akan ditempatkan. Detail lebih lanjut di panduan Halaman Github
Siapkan config.yml Anda
Komit dan dorong ke main
Checkout ke cabang Github Pages Anda (biasanya gh-pages ) dan jalankan git reset --hard origin/main (ini akan mengatur ulang HEAD menjadi master )
Jalankan urlzap generate
Berkomitmen dan dorong
Skrip berikut mengikuti apa yang dijelaskan pada langkah-langkah di atas:
#!/bin/bash# menambahkan, melakukan dan mendorong perubahan Andagit tambahkan config.yml git commit -m 'chore: update config.yml'git push -u origin main# buat cabang gh-pages sama dengan maingit checkout gh-pages git reset --hard origin/main# menghasilkan fileurlzap menghasilkan# menambahkan, melakukan dan mendorong file yang dihasilkangit add --all git commit -m 'tugas: perbarui file HTML'git push -u asal gh-pages --force
