code cookbook

Haxe Code Cookbook

Sumber untuk Situs Buku Masakan Haxe Code, situs web sumber daya yang digerakkan oleh komunitas untuk belajar Haxe dalam praktiknya.

Repositori berisi generator situs web statis, yang mengubah artikel Markdown menjadi situs web. Proyek ini sedang dikembangkan di sini di GitHub, jangan ragu untuk menyumbangkan cuplikan dan tutorial kode terkait HAXE.

Struktur

• Artikel yang sebenarnya ada dalam aset/konten/buku masak, terorganisir per folder.
• File template HTML ada dalam aset/konten/.
• File statis (CSS, JS, gambar) file dalam aset/termasuk/.
• File sumber HAXE dari generator ada di SRC/.
• Konten yang dihasilkan situs web akan output dalam output/ (dikecualikan dari GIT).

Berkontribusi

Kontribusi perubahan

Untuk menyumbangkan perubahan, Anda harus membuat permintaan tarik. Ini dapat dilakukan dengan menggunakan situs web GitHub atau dengan garpu/mengkloning proyek.

Berkontribusi menggunakan github sebagai editor online

Ini adalah cara termudah untuk melakukan perubahan kecil:

• Arahkan ke artikel di https://code.haxe.org dan tekan tombol Edit pada halaman apa pun:
• Anda dialihkan ke GitHub. Setelah Anda memiliki akun dan masuk, Anda dapat membuat perubahan pada editor online.
• Atur deskripsi / apa yang Anda ubah dan tekan tombol Perubahan Permintaan :
• Permintaan tarik akan dibuat. GitHub membuat garpu untuk Anda secara otomatis.

Berkontribusi menggunakan garpu

Ini juga akan memungkinkan untuk menguji/melihat perubahan sebelum mengirimkan yang juga berguna ketika Anda ingin menambahkan halaman baru.

• Buat garpu (di GitHub) dari proyek.
• Lihat repo Anda di mesin Anda, buat cabang baru untuk permintaan tarik.
• Buat perubahan di cabang baru itu.
• Dorong komit (mereka pergi ke garpu Anda).
• Di GitHub, Anda membuat permintaan tarik dari cabang garpu Anda ke repo asli.

Membuat artikel

Harap tambahkan/edit artikel (file markdown) di folder aset dan lakukan permintaan tarik. Ruang lingkup buku masak mencakup bahasa inti, perpustakaan standar, dan juga perpustakaan apa pun yang dikelola oleh Haxe Foundation.

Format

Alangkah baiknya jika Anda menjaga pemformatan kode dalam gaya yang sama seperti yang sudah digunakan:

• Kawat gigi di baris yang sama.
• Lekukan dua ruang.
• Tidak ada jenis-lintasan untuk variabel lokal dan fungsi kembali kecuali itu instruktif.
• Jenis-ria untuk bidang.
• Tipe-hint untuk argumen fungsi kecuali sangat jelas.
• Penggunaan pemotongan garis tambahan yang bijaksana untuk menghindari istirahat otomatis yang jelek (periksa output).

Komentar lainnya

• Judul pertama digunakan dalam navigasi. Jaga judul ini singkat.
• Paragraf pertama digunakan sebagai deskripsi. Jelaskan tentang konten artikel ini.
• Gunakan > Author: [Name](https://github.com/username) untuk menandai diri Anda sebagai penulis artikel tersebut. Kontributor lain disimpulkan dari Git Commit.
• Tag artikel menggunakan [tags]: / "tag1,tag2" (tidak ada spasi). Coba gunakan tag yang ada.
• Sebutkan penulis / sumber di bagian bawah halaman.
• Jika Anda ingin menyertakan cuplikan kode try.haxe.org, gunakan [tryhaxe](https://try.haxe.org/embed/76f24) .
• Jika Anda ingin menyertakan video YouTube, gunakan [youtube](https://www.youtube.com/watch?v=dQw4w9WgXcQ) .
• Jika memungkinkan, tautkan ke halaman terkait dalam dokumentasi manual / API HAXE.
• Jika Anda ingin menggunakan gambar atau termasuk lainnya, buat folder yang disebut aset di direktori yang sama dengan artikel dan tautkan ke sana.

Ini akan menjadi templat khas untuk digunakan. Gunakan ```haxe untuk penyorotan sintaks:

 [Tag]: / "Kelas, Array, JSON, Lingkungan Bangunan"

# Judul halaman

Deskripsi dan Penjelasan Kode.

Implementasi ##
`` `Haxe
kelas utama {
  // kode di sini
}
`` `

## Penggunaan

Deskripsi cara menggunakan/menguji kode.

`` `Haxe
tes kelas {
  // kode di sini
}
`` `

> Lainnya tentang topik ini: 
> 
> * [Bidang Kelas di Haxe Manual] (https://haxe.org/manual/class-field.html)
> 
> Penulis: [name] (https://github.com/username)

Menjalankan Salinan Lokal

Untuk menjalankan proyek, Anda dapat menggunakan Neko:

Hubungi neko CodeCookBook.n untuk menghasilkan kembali file output.

Berkontribusi pada generator

Anda perlu diinstal Haxe 3.4.2+.

Sumber generator situs statis tergantung pada hxtemplo dan haxe-markdown.

Instal perpustakaan menggunakan haxelib, jalankan perintah berikut di root proyek:

 haxelib install all

File CSS dikompresi menggunakan lebih sedikit. Instal dari NPM:

 npm install -g less
npm install -g less-plugin-clean-css