Phenquestions
Markdown standard
Markdown adalah standard yang dikembangkan oleh John Gruber. Matlamat utama dengan Markdown adalah menjadikan fail dapat dibaca walaupun dalam bentuk teks murni. Sekiranya anda ingin melihat dalam editor teks sahaja, anda semestinya senang membacanya. Ini sangat berguna untuk pengguna vim dan yang serupa. Perhatikan, dan ingat bahawa ini adalah standard untuk menukar fail teks. Ia tidak menggantikan HTML. Sebaliknya, anda menggunakannya untuk membuat HTML di mana ia berguna. Dalam kes GitHub, mereka akan memformat fail Readme di laman web ini. Selagi anda mengikuti piawaian, anda boleh yakin bahawa ia akan kelihatan baik.
Oleh kerana GitHub telah menambahkan hanya beberapa sambungan, anda harus bermula dengan menggunakan cheatsheet Markdown dan pergi dari sana. Berikut adalah senarai yang paling biasa.
| Penurunan harga | Sambungan | Keputusan |
| # (1 setiap tahap) | Tajuk | |
| * | Huruf miring | |
| ** | Berani | |
| > | Blockquote | |
| 1. (dan lain-lain.) | Senarai Teratur | |
| - | Senarai tidak tersusun | |
| 'kod' | Kod Anda | |
| "' | Md-ext | Mulakan dan tamatkan sekatan kod |
| - | Peraturan Mendatar | |
| [Penerangan] (https: // www.contoh.com) | Nama dalam petak dan URL dalam tanda kurung biasa | |
| ![teks alt] (gambar.png) | Sama, pautan ke gambar | |
| [1] | Md-ext | Nota kaki |
Senarai boleh disarang dengan memasukkan item yang anda mahu bersarang.
Sambungan lain untuk Markdown biasa, anda mempunyai kod yang menyekat sambungan di atas. Mereka tidak selalu disokong oleh perkhidmatan.
| Penurunan harga | Sambungan | Keputusan |
| ### Tajuk # custom-id | Md-ext | Tajuk yang boleh anda alamatkan dengan IDnya |
| istilah: takrif | Md-ext | Senarai istilah dengan definisi |
| ~ Teks Kesalahan ~ | Md-ext | Teks teguran |
| - [x] Tugas yang perlu dilakukan | Md-ext | Senarai tugas yang boleh anda tandakan |
Jadualnya sangat mudah, tetapi anda memerlukan beberapa baris untuk menunjukkannya: Jadual:
| Nama | NILAI || ----------- | ---------- |
| Tikar | 100 |
Sambungan GitHub.
GitHub telah menambahkan beberapa peluasan untuk mempermudah menangani pautan ke orang lain dan projek. Sebilangannya adalah jadual yang disebutkan sebelumnya. Yang paling banyak membantu anda ialah peluasan pautan automatik. Ini membuat pautan sendiri apabila anda menggunakannya di GitHub.
Yang lain adalah jadual dan item senarai Tugas. Ini sesuai untuk mengawasi tugas anda dalam projek. Yang terakhir disebut adalah sambungan HTML Raw yang Tidak Diizinkan. Dengan bantuan peluasan ini, beberapa tag disaring ketika membuat HTML. Teg ini boleh menyebabkan kesan pelik ketika membuat GitHub.
Kaedah untuk meneroka GitHub Markdown
Sekiranya anda membingungkan, anda juga boleh pergi ke halaman GitHub dan menggunakan editor terbina dalam. Apabila anda menggunakannya, ia akan menyelesaikan beberapa fungsi secara automatik. Ini hanya berfungsi untuk masalah, tetapi anda boleh menggunakannya untuk mengetahui beberapa perkara, emoji keluar sebagai senarai semasa anda menaip titik dua (:).
Anda juga boleh mendapatkan projek di GitHub yang mempunyai fail README yang hebat dan mengklonnya ke pemacu tempatan anda. Dari sana, anda boleh meneroka fail menggunakan editor yang anda mahukan. Untuk editor besar, Emacs dan Vim, ada sokongan untuk penurunan harga melalui peluasan.
Sekiranya anda menggunakan vim, anda boleh memasukkan ekstensi sorotan sintaks dari GitHub, vim-markdown. Sambungan ini menunjukkan bahawa anda telah melakukan kod dengan betul. Untuk membantu anda melihat penampilannya ketika selesai, anda juga boleh mendapatkan lanjutan tanda langsung. Dengan ini, anda boleh menjalankan pelayan web, menunjukkan hasilnya secara langsung semasa anda menaip.
Dengan Emacs, anda mempunyai mod tidak sabar, mod down live dan pratonton Realtime. Semuanya menunjukkan halaman hasil anda di penyemak imbas semasa anda menaip. Yang pertama memerlukan lebih sedikit perpustakaan daripada yang terakhir tetapi memerlukan coretan kod tambahan untuk dijalankan.
Kesimpulannya
Walaupun markdown adalah spesifikasi kecil dan sengaja, sedikit membingungkan untuk memulakannya. Kaedah terbaik untuk belajar adalah dengan menggunakan cheat sheet dan menulis dokumen Markdown anda. Anda boleh mengemas kini README anda.md di GitHub, dan anda boleh mendapat banyak sokongan dari fungsi dalaman editor anda. Sebagai catatan, GitHub juga menyokong emoji yang boleh anda tambahkan ke dokumen anda. Anda boleh menggunakan cheat sheet untuk mencari mana.
Muat turun Markdown-CheatSheet Here
