Mengenal Syntax Markdown untuk dokumentasi program

Buat kamu yang suka bermain dengan Github pasti sudah tidak asing lagi dengan yang namanya syntax markdown. Tak dapat dipungkiri berkat Github syntax markdown ini begitu populer sampai – sampai untuk membuat dokumentasi program yang informatif dan mudah dipahami tak jarang kamu bereksperimen dengan syntax markdown.

Sekilas tentang Syntax Markdown

Markdown adalah (lightweight markup language) bahasa markup yang lebih ringan dari HTML untuk formatting teks. Awal mula dibuatnya syntax markdown bermula dari pengalaman John Gruber dan Aaron Swart pada tahun 2004, ketika ingin melakukan penataan dokumen selalu terkendala untuk menggabungkan konten dengan penataan dokumen ketika itu mereka menggunakan editor WYSIWYG.

Pada dasarnya syntax markdown hampir mirip seperti HTML tetapi lebih sederhana, mudah dibaca, dan ringan dalam melakukan formatting text. Format Markdown hanya menggunakan simbol-simbol yang telah umum dikenal seperti ( # ), ( * ), ( ` ), dan ( – ). Dokumen atau syntax markdown sering disebut “plaintext” dikarenakan formatnya hanya menggunakan simbol-simbol yang ada dalam kode ASCII. Syntax markdown dapat dikonversi keberbagai format termasuk .html .pdf .edp dll.

github-markdown

Dasar penulisan syntax markdown di github

Headings

Untuk membuat heading kamu bisa menambahkan tanda ( # ) sebanyak 1 sampai 6 sebelum heading text. Jika di HTML sama seperti tag h1 s/d h6.

# Largest Heading
## The Second Largest Heading
###### The Smallest Heading

Style pada Text

Untuk memberikan style pada text ada beberapa yang bisa dipakai antara lain bold, italic, atau strikethrough.

Bold bisa menggunakan **This is bold text** atau __This is bold text__
Italic bisa menggunakan *This text is italicized* atau _This text is italicized_
Strikethrough bisa menggunakan ~~This was mistaken text~~

Quote text

Kamu bisa melakukan quote pada text dengan tanda ( > )

> Text with quote

Quote pada code

Untuk membuat quote pada code github menggunakan backtick ( ``` )

```
git status
git add
git commit
```

Membuat Link

Membuat inline link pada text bisa menggunakan wrapping bracket [  ] dan pada URL menggunakan wrapping (  ). Atau kita juga bisa membuat relative link dengan

[Link tukarpengetahuan](https://tukarpengetahuan.com)

relative link ini bisa juga kita gunakan untuk menyisipkan file image

Menyisipkan Gambar

Cara menyisipkan gambar hampir sama dengan membuat link. Hanya saja untuk menyisipkan gambar kamu hanya menambahkan tanda seru ( ! ) di depannya. Jangan lupa sesuaikan letak path directory image tersebut berada.

![Screenshot](img/taskmanager.jpg)

Membuat List

Untuk membuat unordered list pada markdown menggunakan ( – ) atau ( * )

- Text pertama
- Text kedua
- Text ketiga

Sedangkan untuk membuat order list number menggunakan number seperti biasa

1. Text pertama
2. Text kedua
3. Text ketiga

Membuat Task List atau ceklis

Pada github markdown kita bisa membuat ceklis untuk membuatnya kamu hanya butuh bracket kosong lalu diberi spasi seperti ini [  ]. Sedangkan untuk memberikan tanda ceklis kamu bisa menggunakan [ x ]. Tidak semua editor support dengan list ini sejauh ini baru github yang pernah saya coba.

- [ x ] Job pertama selesai
- [   ] Lanjut job kedua
- [   ] Lanjut job ketiga

Membuat garis horizontal

Untuk membuat sebuah garis horizontal bisa menggunakan <hr> atau tanda

Membuat tabel

Untuk membuat sebuah tabel kamu bisa menggunakan cara berikut :

| Nama | Umur |
|------|------|
| Anis |  20  |
| Anto |  15  |

Jika kita terbiasa menulis snytax markdown bisa jadi lama kelamaan kita akan ingat dan tanpa sadar kita sudah menghapalnya. (iwn)

Referensi sumber : https://help.github.com/articles/basic-writing-and-formatting-syntax/

Leave a Reply

Your email address will not be published. Required fields are marked *