Praktik Terbaik untuk Menulis Kode yang Bersih dan Dapat Dipelihara

Saya telah menambahkan item daftar kedua ini sehingga saya memiliki sesuatu untuk dilihat saat menulis gaya.

• Bukan ide buruk juga untuk menambahkan item ketiga.

  Saya pikir mungkin akan baik-baik saja jika hanya menggunakan dua item tetapi tiga item pastinya tidak lebih buruk, dan karena saya sepertinya tidak mengalami kesulitan membuat hal-hal sewenang-wenang untuk diketik, sebaiknya saya sertakan saja.

Setelah daftar semacam ini biasanya saya memiliki pernyataan atau paragraf penutup, karena agak aneh jika melompat langsung ke judul.

Kode seharusnya terlihat oke secara default.

Saya pikir kebanyakan orang akan menggunakan highlight.js atau Prism atau sesuatu jika mereka ingin menata blok kode mereka tetapi itu tidak akan berhasil. Tidak ada salahnya membuatnya terlihat oke di luar kotak, bahkan tanpa penyorotan sintaksis.

Berikut tampilan file tailwind.config.js default pada saat penulisan:

modul.ekspor = {
   membersihkan: [],
   tema: {
     memperpanjang: {},
   },
   varian: {},
   plugin: [],
}

Semoga itu terlihat cukup baik bagi Anda.

Bagaimana dengan daftar bersarang?

Daftar bersarang pada dasarnya selalu terlihat buruk, itulah sebabnya editor seperti Medium bahkan tidak mengizinkan Anda melakukannya, tapi saya rasa karena beberapa dari Anda yang bodoh akan melakukannya, kami harus memikul beban untuk setidaknya membuatnya berfungsi.

1. Daftar bertingkat jarang merupakan ide bagus.
   • Anda mungkin merasa benar-benar "terorganisir" atau semacamnya, tetapi Anda hanya membuat bentuk kotor di layar yang sulit dibaca.
   • Navigasi bertumpuk di UI juga merupakan ide yang buruk, usahakan semuanya serata mungkin.
   • Menyusun banyak folder di kode sumber Anda juga tidak membantu.
2. Karena kita perlu memiliki lebih banyak item, ini satu lagi.
   • Saya tidak yakin apakah kita akan repot menata gaya lebih dari dua tingkat.
   • Dua sudah terlalu banyak, tiga dijamin ide yang buruk.
   • Jika kamu membuat sarang sedalam empat tingkat, kamu termasuk dalam penjara.
3. Dua item bukanlah sebuah daftar, namun tiga item sudah cukup.
   • Sekali lagi tolong jangan menyusun daftar jika Anda ingin orang benar-benar membaca konten Anda.
   • Tak seorang pun ingin melihat ini.
   • Aku kesal karena kita harus repot menata ini.

Hal yang paling menjengkelkan tentang daftar di Markdown adalah elemen <li> tidak diberi tag <p> turunan kecuali ada beberapa paragraf dalam item daftar. Itu berarti saya harus khawatir tentang menata situasi yang menjengkelkan itu juga.

• Misalnya, inilah daftar bertingkat lainnya.

  Tapi kali ini dengan paragraf kedua.

  • Item daftar ini tidak akan memiliki tag <p>
  • Karena masing-masing hanya satu baris

• Tetapi di item daftar tingkat atas kedua ini, mereka akan melakukannya.

  Hal ini sangat mengganggu karena spasi pada paragraf ini.

  • Seperti yang Anda lihat di sini, karena saya telah menambahkan baris kedua, item daftar ini sekarang memiliki tag <p>.

    Ini adalah baris kedua yang saya bicarakan.

  • Terakhir, inilah item daftar lainnya sehingga lebih seperti daftar.

• Item daftar penutup, tetapi tanpa daftar bersarang, karena mengapa tidak?

Dan terakhir sebuah kalimat untuk menutup bagian ini.

Ada elemen lain yang perlu kita gaya

Saya hampir lupa menyebutkan tautan, seperti tautan ini ke situs web Tailwind CSS. Kami hampir membuatnya menjadi biru, tapi itu yang terjadi kemarin, jadi kami memilih abu-abu tua, terasa lebih edgy.

Kami bahkan menyertakan gaya tabel, lihat ini:

Kita juga perlu memastikan kode inline terlihat bagus, seperti jika saya ingin berbicara tentang elemen <span> atau memberi tahu Anda kabar baik tentang @tailwindcss/typography.

Kadang-kadang saya bahkan menggunakan kode dalam judul

Meskipun itu mungkin ide yang buruk, dan secara historis saya kesulitan membuatnya terlihat bagus. Trik "bungkus blok kode dalam backticks" ini benar-benar berfungsi dengan baik.

Hal lain yang pernah saya lakukan sebelumnya adalah memasukkan tag kode ke dalam tautan, seperti jika saya ingin memberi tahu Anda tentang tailwindcss/docs gudang. Saya tidak suka ada garis bawah di bawah backticks tetapi itu sama sekali tidak sebanding dengan kegilaan yang diperlukan untuk menghindarinya.

Kami belum menggunakan h4

Tapi sekarang kita punya. Tolong jangan gunakan h5 atau h6 di konten Anda, Medium hanya mendukung dua level heading karena suatu alasan, dasar binatang. Sejujurnya saya mempertimbangkan untuk menggunakan elemen semu sebelum untuk meneriaki Anda jika Anda menggunakan h5 atau h6.

Kami tidak menatanya sama sekali karena elemen h4 sudah sangat kecil sehingga ukurannya sama dengan body copy. Apa yang harus kita lakukan dengan h5, menjadikannya lebih kecil dari body copy? Tidak, terima kasih.

Namun kita masih perlu memikirkan tentang judul bertumpuk.

Mari kita pastikan kita tidak mengacaukannya dengan elemen h4.

Fiuh, jika beruntung kami telah menata judul di atas teks ini dan terlihat cukup bagus.

Mari tambahkan paragraf penutup di sini sehingga semuanya diakhiri dengan blok teks berukuran layak. Saya tidak dapat menjelaskan mengapa saya ingin semuanya berakhir seperti itu tetapi saya harus berasumsi itu karena menurut saya segala sesuatunya akan terlihat aneh atau tidak seimbang jika ada judul yang terlalu dekat dengan akhir dokumen.

Apa yang saya tulis di sini mungkin sudah cukup panjang, namun menambahkan kalimat terakhir ini tidak ada salahnya.

Penurunan Harga Rasa GitHub

Saya juga menambahkan dukungan untuk GitHub Flavored Mardown menggunakan remark-gfm.

Dengan remark-gfm, kami mendapatkan beberapa fitur tambahan dalam penurunan harga kami. Contoh: literal tautan otomatis.

Tautan seperti www.example.com atau https://example.com akan otomatis diubah menjadi tag a.

Ini juga berfungsi untuk tautan email: contact@example.com.