.IQMN

Panduan menggunakan Markdown untuk dokumentasi aplikasi dan README.md di github

A
IQBAL FARHAN SYUHADA
05 Jun 2024

Markdown adalah bahasa markup ringan yang digunakan untuk memformat teks. Diciptakan oleh John Gruber dan Aaron Swartz pada tahun 2004, Markdown dirancang untuk mudah dibaca dan ditulis oleh manusia, serta mudah dikonversi menjadi HTML dan format lainnya. Markdown sering digunakan untuk membuat dokumentasi, README file, blog post, dan banyak lagi.

Mengapa Menggunakan Markdown?

  1. Sederhana dan Mudah Dipelajari: Markdown memiliki sintaks yang sederhana dan mudah dipahami, bahkan bagi pemula.
  2. Portabilitas: Markdown dapat dikonversi ke berbagai format seperti HTML, PDF, DOCX, dan lainnya.
  3. Konsistensi: Dengan Markdown, Anda dapat dengan mudah menjaga konsistensi format dokumen Anda.
  4. Kompatibilitas: Banyak platform, seperti GitHub, GitLab, dan Bitbucket, mendukung Markdown secara langsung.

Dasar-Dasar Sintaks Markdown

Heading

Untuk membuat heading, gunakan tanda # diikuti dengan spasi. Jumlah tanda # menentukan tingkat heading (dari h1 hingga h6).

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Teks

  • Tebal: Gunakan dua tanda bintang (**) atau garis bawah (__).
  • Miring: Gunakan satu tanda bintang (*) atau garis bawah (_).
  • Garis Tengah: Gunakan dua tanda tilde (~~).

teks tebal teks miring teks garis tengah

**teks tebal** __teks tebal__
*teks miring* _teks miring_
~~teks garis tengah~~

Daftar

  • Daftar Tidak Terurut: Gunakan tanda bintang (*), tanda minus (-), atau tanda plus (+).
-   Item 1
-   Item 2
    -   Item 2a
    -   Item 2b
  • Daftar Terurut: Gunakan angka diikuti dengan titik.
1.  Item 1
2.  Item 2
3.  Item 3

Link

  • Link Teks: Gunakan kurung siku untuk teks dan kurung biasa untuk URL. IQMN 
[IQMN](https://iqmn.my.id/)
  • Link Gambar: Gunakan tanda seru di depan kurung siku untuk teks alt dan kurung biasa untuk URL gambar. Logo Google 
![Logo OpenAI](https://www.openai.com/assets/images/openai-logo.svg)

Blockquote

Gunakan tanda > di awal baris.

ini adalah blockquote

> Ini adalah blockquote.

Kode

  • Kode Inline: Gunakan backticks (`).

Ini adalah kode inline.

  • Kode Blok: Gunakan tiga backticks atau indentasi empat spasi.

`Ini adalah kode blok.`

Tabel

Gunakan tanda pipa (|) untuk memisahkan kolom dan tanda minus (-) untuk membuat header.

Syntax Description
Header Title
Paragraph Text 
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

Garis Horisontal

Gunakan tiga atau lebih tanda minus (---), tanda bintang (***), atau garis bawah (___).

---
***
___