haxeflixel.com

flixel | addons | Ui | demo | Alat | Template | Docs | haxeflixel.com

Tentang

Ini adalah sumber haxeflixel.com. Menggunakan 11 puluh untuk pembuatan situs statis, dan Bootstrap 5 untuk gaya.

Anda harus memiliki NPM / NODEJS untuk mengkompilasi situs, permintaan tarik dipersilakan.

0. Instal Nodejs

1. Klon dan jalankan situs

   git clone https://github.com/HaxeFlixel/haxeflixel.com.git
   cd haxeflixel.com

   Untuk menginstal dependensi dan membangun situs, jalankan perintah berikut:

    # downloads dependencies, and clones flixel-docs
   npm install
   
   # runs the start command from package.json, which boots up the static site generator and scss styling for live reload
   npm run start

2. Buka http: // localhost: 8080/

3. Mulailah meretas dengan memodifikasi content/ , content/_layouts/ , dan content/_scss/ direktori. Situs ini akan hidup kembali saat Anda menyimpan file yang Anda modifikasi.

Lihat Kode Kontribusi untuk lebih banyak informasi pengembangan.

Dokumentasi yang berkontribusi (demo dan showcases)

Jika Anda ingin berkontribusi dan meningkatkan situs web kami, silakan kerjakan cabang garpu atau fitur. Hanya perubahan yang berfungsi dan diuji yang akan digabungkan menjadi master. Gunakan sistem masalah untuk dukungan dan persetujuan pengembang atas perubahan Anda.

Cara menambahkan dokumentasi

Dokumentasi untuk /documentation ditarik secara otomatis dari repositori Flixel-Docs (melalui skrip preinstall package.json yang menjalankan skrip /install-flixel-docs-repo.js).

Harap tinjau ReadMe di repo Flixel-Docs untuk info lebih lanjut tentang memperbarui halaman haxeflixel.com/documentation.

Bagaimana menambahkan demo

1. Buat file .md di /content/demos mengikuti contoh ini:

    ```
       ---
       title: "Demo-Name"
       layout: demo
       width: 800
       height: 500
       source: "flixel-demos-subdirectory/Demo-Name"
       ---
       Here goes the actual description of the demo in  GitHub-Flavored-Markdown:
       * What the demo displays
       * Who created it
       * What the controls are
       * etc
   
       HTML is still allowed and can be used for more advanced descriptions.
   
   ```
   

   source menunjuk ke subdirektori flixel-demos yang berisi demo.

width dan height default ke 640 dan 480 dan harus dihilangkan dalam kasus itu.

2. Tambahkan tangkapan layar dari demo bernama Demo-Name.png ke /static/demos/images .

Cara menambahkan game showcase

1. Buat file .md di /content/showcase mengikuti contoh ini:

    ---
    layout: showcase
    title: "Go! Go! PogoGirl"
    itch: https://ohsat-andrej.itch.io/go-go-pogogirl
    website: https://www.ohsat.com/game/go-go-pogogirl/
    steam: https://store.steampowered.com/app/1681010/Go_Go_PogoGirl/
    switch: https://www.nintendo.com/store/products/go-go-pogogirl-switch/
    ps4: https://store.playstation.com/en-us/product/UP0891-PPSA10169_00-GOGOPOGOGIRLRATG
    xbox: https://www.microsoft.com/store/productid/9P10H7L6QCCJ
    date: "2022-02-01"
    ---

    Dates should use YYYY-MM-DD

    Note that by adding a URL to one of the supported targets, the icon will automatically become coloured on the
    [showcase page](https://haxeflixel.com/showcase) and link to that URL.

2. Tambahkan tangkapan layar showcase menggunakan judul yang sama yang digunakan dalam file *.md , misalnya Go! Go! PogoGirl.png ke /static/images/showcase . Mereka diubah ukurannya dan dipotong menjadi 500x260, jadi yang terbaik adalah menggunakan rasio yang sama.

Showcases yang belum dirilis secara resmi hanya diterima dalam kasus khusus. Hal yang sama berlaku untuk game dari Game Jams.

Kode yang berkontribusi

Seiring dengan menginstal dan menjalankan perintah secara normal (lihat tentang), ada perintah / alur kerja lainnya yang berguna.

Semua yang Anda butuhkan harus diinstal dengan npm install . Menggunakan vScode Anda juga dapat menginstal ekstensi yang disarankan untuk pemformatan otomatis (pada simpan file). Namun semua alur kerja harus sepenuhnya dapat digunakan melalui CLI.

content/_static

Semua file statis (biasanya / kebanyakan gambar) dapat disalin ke direktori root situs dengan info direktori mereka tetap tidak ada. Jadi content/_static/images/ akan berubah menjadi out/images , dan harus direferensikan dari situs dengan hanya /images/ .

Perintah yang bermanfaat

npm run start

Menjalankan npm run start akan memulai Situs Eleventy dan Sass .scss, dan akan memuat ulang perubahan.

npm test

Menjalankan npm test akan menjalankan tes pemformatan dan linting untuk proyek tersebut. Anda cukup menjalankan npm test jika Anda ingin menjalankan semua tes ( test:js , test:liquid dan test:prettier ).

Namun Anda dapat menjalankan setiap tes secara individual.

• npm run test:js akan menguji JavaScript melalui Standard. Untuk secara otomatis memperbaiki semua, Anda dapat menjalankan npm run Run Fix: JS`

• npm run test:liquid akan menguji apakah situs tersebut dibangun melalui eleventy --dryrun .

• npm run test:prettier akan menguji konsistensi gaya umum menggunakan lebih cantik. Anda dapat menjalankan npm run fix:prettier sebagai cara mudah untuk memperbaiki ketidakkonsistenan.

npm fix

Menjalankan npm fix akan melakukan pemformatan otomatis ke kode untuk mencocokkannya dengan standardjs , .liquidrc , dan .prettierrc.yaml . Biasanya Anda ingin berlari sebelum mengirimkan PR!