alexwlchan.net

Alexwlchan.net

Repo ini memiliki kode untuk situs pribadi saya, Alexwlchan.net, yang merupakan situs statis yang dibangun dengan Jekyll. Ini termasuk sejumlah plugin yang saya tulis untuk menyesuaikan situs.

Alat utama

Situs menggunakan:

• Jekyll, yang menghasilkan halaman html
• Sass, untuk membangun CSS dan stylesheets
• Tindakan GitHub, yang membangun dan menggunakan situs tersebut
• Caddy, yang merupakan server web

Ketika saya ingin melakukan perubahan, saya membuka permintaan tarik. Ini memicu build dengan tindakan GitHub, dan sebagai bagian dari build itu memeriksa HTML dengan HTMLProofer. Ini memeriksa teks alt yang hilang, tautan rusak, html tidak valid, dan sebagainya.

Jika situs melewati cek, itu secara otomatis digabungkan, dan build di cabang main menerbitkan perubahan ke server web saya.

Membangun situs

Anda membutuhkan git, ruby, dan python terpasang.

Untuk menjalankan salinan situs lokal:

$ git clone [email protected]:alexwlchan/alexwlchan.net.git

$ python3 -m venv .venv
$ pip install -r requirements.txt

$ bundle install

$ bundle exec jekyll serve

Situs harus berjalan di http: // localhost: 5757. Jika Anda membuat perubahan pada file sumber, itu akan secara otomatis memperbarui.

Untuk membangun satu set file html statis sekali saja:

$ bundle exec jekyll build

Ini membuat satu set file html di _site .

Cara Kerja Situs

Saya menerbitkan kode sumber sehingga orang lain dapat melihat bagaimana situs tersebut bekerja, dan mungkin menggunakan beberapa ide untuk situs mereka sendiri. Ini adalah daftar hal -hal yang menurut saya menarik atau tidak biasa:

• Generasi pakan atom
• No-Javascript Twitter Embeds
• Menghubungkan ke pekerjaan saya di situs lain
• Memvalidasi materi depan dalam file -file markdown

Berkontribusi

Perbaikan untuk kesalahan ketik dipersilakan, tetapi sebaliknya kontribusi akan diabaikan.

Jika Anda ingin menggunakan salah satu komponen dalam proyek Anda sendiri - plugin, tata letak, stylesheet - jangan ragu untuk melakukannya.

Lisensi

• Kecuali jika dicatat, situs dan kode terkait dilisensikan ganda sebagai:

  • Atribusi Creative Commons 4.0 International (alias CC oleh 4.0)
  • Lisensi MIT

  Jika Anda menggunakan kembali konten saya, Anda dapat menggunakan lisensi mana pun yang paling tepat.

  Sebagian besar CC dengan baik, tetapi lisensi Creative Commons tidak cocok untuk kode, jadi saya memiliki MIT sebagai alternatif.

• Beberapa gambar yang digunakan di bawah lisensi Creative Commons dari orang lain; Lihat posting di mana gambar digunakan untuk atribusi.

• Semua ikon di situs digunakan di bawah lisensi bebas royalti dari proyek kata benda; Harus ada komentar dalam file SVG yang menunjukkan sumbernya. Penulis ikon asli mempertahankan hak cipta.