Highlight Note dan Warning di GitHub Markdown

Highlight Note dan Warning di GitHub Markdown

githubmarkdowntips
Akhmad Salafudin on 19 Mar 2024

Github Markdown

Markdown adalah bahasa markup ringan dengan sintaks pemformatan teks biasa, dirancang untuk dengan mudah dikonversi menjadi HTML dan format lainnya. GitHub Markdown, sering disebut sebagai GFM (GitHub Flavored Markdown), merupakan perluasan dari Markdown standar, yang dirancang khusus untuk digunakan di platform GitHub

Note di Markdown

Saat menulis note atau catatan kaki di markdown biasanya kita menggunakan blockquote atau >. Contoh:

> This is a note

Kode di atas akan ditampilkan sebagai berikut:

This is a note

Percantik Tampilan Note di GitHub Markdown

Pada bulan mei 2022, Github menambahkan fitur untuk mempercantik tampilan note atau warning di github markdown. Beberapa syntax telah dipublikasikan dan telah mengalami beberapa perubahan. Berikut adalah syntax official terakhir untuk menampilkan note di github markdown:

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

kode di atas akan dirender oleh github menjadi tampilan yang cantik dan elegan seperti berikut: Preview github Note dan Warning Bagus bukan? Silakan kalian coba terapkan saat membuat README atau catatan apapun di github markdown.

Diskusi (0)

Silakan Login untuk berdiskusi