Makeup Kit for Creating a README on GitHub
File README di repositori GitHub berfungsi sebagai dokumen pengantar dan informatif untuk proyek tertentu. Ini biasanya berisi informasi penting tentang proyek, membantu pengembang dan pengguna memahami apa proyek, bagaimana menggunakannya, dan bagaimana berkontribusi.
README yang dibuat dengan baik sangat penting untuk keberhasilan proyek open source di GitHub. Ini membantu pengguna potensial dengan cepat memahami tujuan dan fungsionalitas proyek, dan membimbing kontributor tentang bagaimana untuk terlibat dengan proyek secara efektif. README yang jelas dan komprehensif berkontribusi pada pengalaman pengguna yang positif dan mendorong kolaborasi dalam komunitas open source.
Makeup Kit for Creating a README on GitHub :
- Text Editor (Foundation)
- Markdown (Concealer)
- Headers (Blush)
- Lists (Eyeshadow)
- Links (Lipstick)
- Images (Mascara)
- Code Blocks (Eyeliner)
- Tables (Highlighter)
- Badges (Accessories)
- Sections (Perfume)
Text Editor (Foundation):
Deskripsi : Editor teks yang dapat diandalkan berfungsi sebagai dasar untuk membuat README Anda. Pilih yang sesuai dengan preferensi Anda dan mendukung Markdown untuk pemformatan yang mudah.
Contohnya : Visual Studio Code, Sublime Text, Atom.
Markdown (Concealer):
Deskripsi : Markdown adalah concealer yang mempercantik README Anda, membuatnya dapat dibaca dan terstruktur dengan baik. Gunakan untuk judul, daftar, tautan, dan banyak lagi
Contohnya : Pelajari sintaks Markdown di sini.
Headers (Blush):
Deskripsi : Headers menambahkan sentuhan blush ke README Anda, memberikan struktur dan hierarki ke konten Anda.
Contohnya :
# Main Header
## Subheader ### Sub-subheader
Linebreaks
Linebreaks digunakan untuk menulis ke baris baru, Anda dapat memilih cara markdown atau cara HTML. Keduanya bekerja dengan baik.
Hanya tambahkan tag break (<br>)
contohnya :
HTML way <br>of breaking
Lists (Eyeshadow):
Deskripsi : seperti bayangan mata, meningkatkan visibilitas dan organisasi konten Anda. Gunakan mereka untuk daftar yang diatur dan tidak diatur.
Contohnya :
- Item 1
- Item 2
- Subitem
2.1 1. Ordered Item 1 2. Ordered Item 2
Links (Lipstick):
Link bertindak seperti lipstick, menambahkan warna dan gaya ke README Anda. Gunakan mereka untuk mengarahkan pengguna ke sumber daya terkait.
Contohnya :
[GitHub](https://github.com)
Images (Mascara):
Images seperti mascara, meningkatkan daya tarik visual dari README Anda. Tambahkan screenshot atau diagram untuk membuatnya lebih menarik.
Contohnya :



Code Blocks (Eyeliner):
Code blocks adalah eyeliner, menekankan snippets kode Anda. Gunakan backstick untuk kode inline dan triple backtick untuk blok kode multi-line.
Contohnya :
`inline code`
javascriptconsole.log("Multi-line code block");
Tables (Highlighter):
Deskripsi : Tabel bertindak sebagai highlight, menarik perhatian pada detail tertentu dengan cara yang terstruktur. Buat tabel menggunakan pipa { | } untuk memisahkan kolom dan hyphens untuk pemisah header-row.
Contohnya :
markdown| Header 1 | Header 2 |
| -------- | -------- |
| Content 1| Content 2|
Badges (Accessories):
Deskripsi : Badges seperti aksesoris, menambahkan keunggulan ke README Anda. Gunakan mereka untuk menampilkan status build, versi, atau informasi lain yang relevan.
Contohnya :
markdown[](http
Sections (Perfume):
Sections seperti parfum, mendefinisikan esensi unik dari bagian yang berbeda dari README Anda. Gunakan mereka untuk membagi dan mengatur konten.
Contohnya :
markdown<!-- Section 1 -->
## Introduction
<!-- Section 2 -->
## Installation
Call to Action (Finishing Touch):
The call to action adalah sentuhan akhir, mengundang pengguna untuk berkontribusi, mengajukan pertanyaan, atau mengeksplorasi lebih lanjut.
Contohnya :
markdown## Contribute
Feel free to contribute by...
## Questions
If you have any questions, please open an issue or reach out to
[email@example.com](mailto:email@example.com).
Text Formatting:
Gunakan asterisk atau underscore untuk teks italic, double asterisks atau underscores untuk teks Bold, dan backstick untuk kode inline.
contohnya :
markdown*italic*
**bold**
__Bold___Italic____Hybird___**_Hybrid_***__Hybrid__*`inline code`
Horizontal Rules:
Insert a horizontal rule using three hyphens, underscores, or asterisks.
markdown---
***------
Quotes:
Use the greater-than symbol (>) to create block quotes.
contohnya :
markdown> This is a quote.
> >This is nested Blockquote> >> >Let’s get out of nested
Task Lists:
Create task lists with checkboxes using square brackets and hyphens.
contohnya :
markdown- [x] Task 1
- [ ] Task 2
Escaping Characters:
Use a backslash to escape characters that have a special Markdown meaning.
markdown\*Escaped Asterisks\*
Labels :
Here is code to a few labels below. Feel free to use. Mention your Github Username and repository name in the space mentioned.
markdown
Add color:
markdown```diff- This is a red colored line+ This is a green colored line@@ This is a purple colored line @@```
Comments
Post a Comment