Pertemuan Pertemuan 10

Markdown, README, License & GitHub Pages

Pertemuan 10 / 32
Basic Modul 1.5 60 menit
Pertemuan 10

Markdown, README, License & GitHub Pages

Tujuan Pembelajaran

  • Menguasai sintaks Markdown untuk dokumentasi
  • Mampu menulis README.md yang profesional
  • Memahami jenis-jenis license open source
  • Mengenal GitHub Pages untuk hosting website statis

Materi Inti

A. Sintaks Markdown

Markdown adalah bahasa markup ringan yang digunakan di GitHub untuk menulis dokumentasi, README, issues, dan komentar. Berikut sintaks dasarnya:

# Heading 1
## Heading 2
### Heading 3

**Teks tebal**
*Teks miring*
~~Teks dicoret~~
`kode inline`

- Item list 1
- Item list 2
  - Sub item

1. Numbered list
2. Item ke-2

[Teks link](https://url.com)
![Alt text gambar](gambar.png)

> Ini adalah blockquote

| Kolom 1 | Kolom 2 |
|---------|---------|
| Data 1  | Data 2  |

Tips: Kamu bisa langsung mempraktikkan Markdown di GitHub saat menulis README, Issues, atau Pull Request. GitHub akan otomatis me-render Markdown menjadi tampilan yang rapi.

B. Template README.md Profesional

README.md adalah file pertama yang dilihat pengunjung repo. File ini harus menjelaskan project secara ringkas dan informatif.

Struktur README yang baik:

# Nama Project

Deskripsi singkat project (1-2 kalimat).

## Fitur
- Fitur 1
- Fitur 2

## Instalasi
```bash
git clone https://github.com/user/project.git
cd project
npm install

Cara Penggunaan

npm start

Kontribusi

  1. Fork repo ini
  2. Buat branch fitur (git switch -c fitur-baru)
  3. Commit perubahan (git commit -m "Tambah fitur baru")
  4. Push ke branch (git push origin fitur-baru)
  5. Buat Pull Request

Lisensi

MIT License — lihat file LICENSE


> **Warning:** README yang kosong atau hanya berisi judul membuat project terlihat tidak profesional dan sulit digunakan orang lain.

### C. Jenis License Open Source

License menentukan bagaimana orang lain boleh menggunakan kode kamu.

| License | Boleh komersial? | Harus open source? | Cocok untuk |
|---------|-----------------|-------------------|-------------|
| MIT | Ya | Tidak | Project kecil-menengah |
| Apache 2.0 | Ya | Tidak | Project besar, perlindungan paten |
| GPL v3 | Ya | Ya (turunan harus GPL juga) | Project yang ingin tetap open source |
| Unlicense | Ya | Tidak | Dedikasi domain publik |

> **Tips:** Jika ragu, gunakan **MIT License**. Ini license paling populer dan paling permisif -- membolehkan siapa saja menggunakan kode kamu untuk apapun.

### D. GitHub Pages

GitHub Pages adalah layanan hosting website statis gratis dari GitHub. Cocok untuk portfolio, dokumentasi project, atau blog sederhana.

**Cara mengaktifkan GitHub Pages:**

1. Buka repository di GitHub
2. Pergi ke **Settings** lalu **Pages**
3. Di bagian Source, pilih **Deploy from a branch**
4. Pilih branch `main` dan folder `/ (root)`
5. Klik **Save**
6. Website akan live di: `https://USERNAME.github.io/REPO-NAME/`

---

## Demonstrasi Live

### Menulis README dan Deploy ke GitHub Pages

```bash
# Buat project baru
mkdir website-saya && cd website-saya && git init

# Buat file HTML sederhana
cat > index.html << 'EOF'
<!DOCTYPE html>
<html>
<head><title>Website Saya</title></head>
<body>
  <h1>Selamat Datang!</h1>
  <p>Website ini di-deploy dengan GitHub Pages.</p>
</body>
</html>
EOF

# Buat README.md profesional
cat > README.md << 'EOF'
# Website Saya

Website personal sederhana yang di-deploy menggunakan GitHub Pages.

## Fitur
- Halaman utama responsif
- Hosting gratis via GitHub Pages

## Cara Deploy
1. Fork repo ini
2. Aktifkan GitHub Pages di Settings
3. Website otomatis live!

## Lisensi
MIT License
EOF

# Tambahkan license
# (Di GitHub, klik Add File > Create new file > ketik LICENSE > pilih template MIT)

# Commit dan push
git add .
git commit -m "Tambah website dan README"
git remote add origin git@github.com:USERNAME/website-saya.git
git push -u origin main

# Aktifkan GitHub Pages di Settings > Pages > Source: main branch

Latihan Interaktif

Latihan Terminal (Hands-on)

Langkah 1: Tulis README.md profesional untuk salah satu project kamu

cd project-kamu

# Buat atau edit README.md
# Harus mencakup: judul, deskripsi, fitur, instalasi, penggunaan, lisensi

Langkah 2: Deploy website sederhana ke GitHub Pages

# 1. Buat repo baru di GitHub (atau pakai yang sudah ada)
# 2. Buat file index.html
# 3. Push ke GitHub
git add .
git commit -m "Tambah halaman untuk GitHub Pages"
git push origin main

# 4. Di GitHub: Settings > Pages > Source: Deploy from branch > main > / (root)
# 5. Tunggu beberapa menit, website live di:
#    https://USERNAME.github.io/REPO-NAME/

Tugas Mandiri

  1. Tulis README.md lengkap untuk minimal 2 repo kamu (harus ada: judul, deskripsi, fitur, instalasi, penggunaan, lisensi)
  2. Tambahkan file LICENSE (pilih MIT) ke 1 repo — bisa lewat GitHub interface
  3. Deploy 1 website sederhana (HTML/CSS) ke GitHub Pages dan pastikan bisa diakses