website metalsmith

Rekatkan Website

PERINGATAN :
Repositori ini adalah rumah sebelumnya dari situs web Fictify hingga Juni 2023.
Rumah baru sekarang fastify/website-next

Proyek ini digunakan untuk membangun situs web untuk mengupas kerangka kerja web dan mempublikasikannya secara online.

Persyaratan

• Node 12+
• Instal dependensi dengan npm install

Membangun

Untuk memicu pembangunan situs web yang hanya perlu Anda jalankan:

npm run build

Ini akan menjalankan semua langkah yang diperlukan untuk membuat build (situs web statis).

Jika Anda berkembang, Anda dapat menjalankan:

npm start

Ini akan memicu build dan juga memulai server langsung yang akan memungkinkan Anda untuk memvisualisasikan perubahan yang Anda lakukan di situs web.

(Perhatikan bahwa setiap kali Anda melakukan perubahan pada aset yang merupakan konten situs web yang Anda perlukan untuk meluncurkan npm run build:website untuk memicu pembangunan kembali)

Membangun langkah

Jika Anda tertarik untuk mengetahui lebih banyak tentang cara kerja proses pembangunan, berikut adalah langkah -langkah utama yang dilakukan selama pelaksanaannya:

1. Pembersihan : Menghapus sumber daya sementara yang mungkin dibuat dari bangunan sebelumnya
2. Penciptaan folder temp : Membuat folder yang dibutuhkan untuk proses pembangunan
3. Dapatkan Rilis : Menggunakan API GitHub untuk mengunduh rilis terbaru dari Freattify sehingga halaman dokumentasi dapat diregenerasi secara dinamis.
4. Rilis Proses : Proses Rilis Membuat semua file dinamis yang diperlukan yang diturunkan dari rilis pengupasan asli (sebagian besar digunakan untuk menghasilkan dan memproses halaman dokumentasi)
5. Generasi Situs Web : Menggunakan Metalsmith untuk mengkompilasi versi statis situs web.

Lihat skrip paket untuk memahami file mana yang memicu tindakan ini jika Anda ingin melihat kode untuk salah satu langkah yang dijelaskan di atas.

Menerbitkan sebagai halaman GitHub

Situs web ini diterbitkan secara otomatis Circle CI menggunakan halaman GitHub ( gh-pages Cabang).

Setiap kali ada perubahan pada master, jika build itu dibuat dengan sukses, maka secara otomatis diterbitkan di halaman GitHub.

Agar ini berfungsi, lingkaran CI perlu dikonfigurasi dengan benar menyediakan semua variabel lingkungan yang diperlukan:

• DOMAIN : Domain khusus yang akan digunakan di halaman GitHub ( www.fastify.io )
• GH_EMAIL : Email pengguna github yang diotorisasi di Circleci untuk mendorong ke cabang gh-pages
• GH_NAME : Nama pengguna pengguna GitHub yang diotorisasi di Circleci untuk mendorong ke cabang gh-pages
• GH_TOKEN : (Opsional) Token akses pribadi GitHub untuk pengguna yang ditentukan dalam GH_NAME . Jika ini ada panggilan API ke GitHub akan diautentikasi.
• CLOUDFLARE_EMAIL : Email dari akun cloudflare
• CLOUDFLARE_AUTH_KEY : Kunci otorisasi untuk melakukan panggilan API di API Cloudflare
• CLOUDFLARE_ZONE : ID zona cloudflare yang terkait dengan domain saat ini

Berkontribusi

Setiap orang dipersilakan untuk berkontribusi pada proyek ini. Anda dapat berkontribusi hanya dengan mengirimkan bug atau menyarankan perbaikan dengan membuka masalah atau dengan mengirim permintaan tarik.

Lisensi

Berlisensi di bawah lisensi MIT. © OpenJS Foundation dan tim pengupas.