markdown dungeon

⚔️ Markdown Dungeon ⚔️

Dungeon adalah tempat atau penjara tempat orang ditahan. Biasanya, mereka dapat ditemukan di bawah tanah

Ini adalah contoh ilustrasi repo ruang bawah tanah menggunakan Markdown on GitHub. Di ruang bawah tanah, pembaca memilih opsi mana yang harus diambil dan melompat ke halaman ruangan yang sesuai yang didasarkan pada pilihan mereka. Ini kolaboratif karena ruangan ini ditulis oleh banyak penulis.

Mulai game baru

? Instalasi

Anda perlu menginstal benang.

1. Kloning repo

git clone https://github.com/MakeContributions/markdown-dungeon.git

2. Pergi ke folder

 cd markdown-dungeon

3. Jalankan Instal Ketergantungan

yarn

4. Buat file .env.development di folder root proyek dan salin format file .env.example .
5. Untuk memulai server pengembangan, jalankan:

yarn start

Pastikan Anda tidak menggunakan PowerShell

6. ? Buka browser Anda dan buka http: // localhost: 8000/atau http: // localhost: 8000/___ graphql

Format lantai dan kamar

Lantai adalah folder dan setiap lantai adalah koleksi kamar dan setiap kamar adalah file Markdown . Tautan kemampuan penurunan harga digunakan untuk naik/turun dan pergi ke ruangan lain, seperti contoh di bawah ini.

Pergi ke Dungeon GitHub

 [ Go to Github dungeon ] ( https://github.com/ ) 

? ‍ Pedoman Kontribusi

1.? Membuat perubahan ukuran yang memadai

• Simpan perubahan kecil
• Jangan menambahkan opsi tanpa menambahkan gerbang apa pun untuk pembaca yang memutuskan opsi itu, sehingga ruang bawah tanah tidak akan penuh dengan tautan mati. Sebaliknya, file markdown terakhir yang dicapai pembaca di jalur ruangan apa pun seharusnya tidak memiliki opsi.

Berikut adalah beberapa contoh perubahan yang sesuai:

• Tambahkan satu atau dua kalimat ke "halaman" yang ada (file) di dalam ruangan.
• Tambahkan opsi baru ke titik pilihan yang ada, dan tautkan opsi itu ke "kamar" atau "lantai" yang ada.
• Tambahkan opsi baru ke titik pilihan yang ada, buat "halaman" baru untuk opsi itu, dan tambahkan satu atau dua kalimat ke "halaman" baru.
• Tambahkan beberapa opsi ke "halaman" buntu saat ini, dan tambahkan "halaman" atau tautan ke "halaman" yang ada untuk setiap opsi.

2. ⛩ struktur penjara bawah tanah

Struktur harus menjadi dungeon-name/floor-number/room-number , silakan lihat definisi di bawah ini untuk setiap variabel:

• Dungeon-name: adalah folder yang berisi nomor lantai, harus memisahkan kata-kata dengan tanda hubung (-), adalah alfanumerik. Contoh: Normal-Dungeon-1 .
• Nomor Lantai: adalah folder yang berisi nomor kamar, adalah numerik jangan menambahkan 0 sebelum nomor.

 1, 2, 3 // Compliance

01, 02, A3 // Non-Compliance

• Kamar-nomor: adalah file penurunan harga, nama file harus di numerik, tetapi jika memiliki sub-kamar ruangan Anda dapat memisahkan nomor kamar dengan tanda hubung (-), sub ruang bisa alfanumerik.

 1, 2, 3-AF, 3-01 // Compliance

01A, 02*A3, A3+F // Non-Compliance

Folder atau nama file hanya menerima semua karakter ASCII dan dasbor (-).

Jika Anda membuat ruang bawah tanah baru, silakan tambahkan mulai game baru, tambahkannya di folder gambar, dan di Dungeon-Info.json, sehingga pembaca dapat pergi ke ruang bawah tanah Anda dan membukanya di situs web

Jika Anda ingin mendapatkan gambaran tentang opsi mana yang mengarah pada apa yang berkontribusi, cari file decision_tree.png di bawah folder penjara bawah tanah apa pun, yang berisi pandangan grafis dari penjara bawah tanah itu.

3.? Gunakan tautan relatif

Tautan dalam file ini harus berupa tautan relatif untuk terus bekerja jika repositori bercabang.

4.? Panjang garis

Simpan semua baris 120 karakter atau kurang. Jika tidak, file mentah akan sulit dibaca di browser atau pada baris perintah, dan perubahan akan lebih sulit untuk ditinjau.

5.? Garis kosong antara opsi

Masukkan garis kosong antara berbagai opsi sehingga opsi dipisahkan secara visual.

Lisensi

Mit