Menulis Konten¶

Garudea Docs menggunakan Markdown dengan ekstensi tambahan dari Material for MkDocs. Halaman ini menjelaskan semua fitur yang bisa digunakan saat menulis dokumentasi.

Markdown Dasar¶

Heading¶

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

Teks¶

**Bold** atau __bold__
*Italic* atau _italic_
~~Strikethrough~~

Link¶

[Teks Link](https://garudea.com)
[Link ke halaman lain](../erp/index.md)
[Link ke section](#admonitions)

Gambar¶

Letakkan gambar di folder yang sama dengan file .md, lalu referensikan:

![Deskripsi Gambar](nama-gambar.png)

Penamaan File Gambar

Gunakan huruf kecil dan tanda hubung (-), bukan spasi
Contoh: setup-master-data.png bukan Setup Master Data.png
Format yang didukung: .png, .jpg, .gif, .svg

Tabel¶

| Kolom 1 | Kolom 2 | Kolom 3 |
|---------|---------|---------|
| Data 1  | Data 2  | Data 3  |
| Data 4  | Data 5  | Data 6  |

Hasil:

Kolom 1	Kolom 2	Kolom 3
Data 1	Data 2	Data 3
Data 4	Data 5	Data 6

Ordered & Unordered List¶

1. Item pertama
2. Item kedua
3. Item ketiga

- Item A
- Item B
- Item C

Fitur Material for MkDocs¶

Admonitions¶

Admonitions adalah callout box untuk menyoroti informasi penting. Tersedia beberapa tipe:

!!! note "Judul Note"

    Ini adalah catatan penting.

!!! tip "Tips"

    Ini adalah tips berguna.

!!! warning "Peringatan"

    Ini adalah peringatan.

!!! danger "Bahaya"

    Ini adalah informasi kritis.

!!! info "Informasi"

    Ini adalah informasi tambahan.

!!! example "Contoh"

    Ini adalah contoh.

Hasil:

Judul Note

Ini adalah catatan penting.

Tips

Ini adalah tips berguna.

Peringatan

Ini adalah peringatan.

Bahaya

Ini adalah informasi kritis.

Admonition juga bisa dilipat (collapsible) dengan ???:

??? note "Klik untuk buka"

    Konten tersembunyi yang bisa dibuka.

Klik untuk buka

Konten tersembunyi yang bisa dibuka.

Content Tabs¶

Untuk menampilkan konten dalam tab (misal: langkah untuk OS berbeda):

=== "Windows"

    Jalankan di Command Prompt:
    ```
    pip install mkdocs-material
    ```

=== "Linux/Mac"

    Jalankan di Terminal:
    ```
    pip3 install mkdocs-material
    ```

Hasil:

WindowsLinux/Mac

Jalankan di Command Prompt:

pip install mkdocs-material

Jalankan di Terminal:

pip3 install mkdocs-material

Code Blocks¶

Syntax highlighting otomatis dengan menentukan bahasa:

```python
def hello():
    print("Hello, World!")
```

```yaml
theme:
  name: material
```

```bash
mkdocs serve
```

Task Lists¶

- [x] Task yang sudah selesai
- [ ] Task yang belum selesai
- [ ] Task lainnya

Hasil:

Task yang sudah selesai
Task yang belum selesai
Task lainnya

Tombol¶

[Klik Saya](https://garudea.com){ .md-button }
[Primary Button](https://garudea.com){ .md-button .md-button--primary }

Hasil:

Klik Saya Primary Button

Footnotes¶

Teks dengan catatan kaki[^1].

[^1]: Ini adalah catatan kaki.

Panduan Screenshot¶

Karena dokumentasi Garudea sangat bergantung pada screenshot, ikuti panduan ini:

Penamaan¶

Format: deskripsi-singkat.png (lowercase, gunakan -)
Contoh: create-invoice.png, setup-coa.png, payroll-config.png

Lokasi¶

Simpan di folder yang sama dengan file .md yang mereferensikannya
Jangan buat subfolder khusus untuk gambar kecuali jumlahnya sangat banyak (50+)

Ukuran¶

Lebar ideal: 800-1200px
Gunakan tool kompresi jika file > 500KB
Format .png untuk screenshot UI, .jpg untuk foto

Glightbox¶

Semua gambar otomatis mendapat fitur click-to-zoom berkat plugin glightbox. Tidak perlu konfigurasi tambahan — cukup masukkan gambar dengan syntax markdown biasa.

Template Halaman¶

Template untuk Admin Guide / Konfigurasi¶

# Konfigurasi [Nama Modul]

Penjelasan singkat tentang konfigurasi modul ini.

## Settings

Ketika menu ini di klik akan ditampilkan fungsi-fungsi yang diinstal pada modul saat ini.

![Settings](settings.png)

## [Master Data 1]

Langkah-langkah untuk setup:

1. Klik Create
2. Isi field yang diperlukan

    ![Create](create-master.png)

3. Klik Save

## [Master Data 2]

...

Template untuk User Manual¶

# [Nama Modul]

Penjelasan singkat tentang modul dan fungsinya.

## Alur Kerja

Berikut adalah alur kerja umum modul ini:

1. **Step 1** — Deskripsi
2. **Step 2** — Deskripsi
3. **Step 3** — Deskripsi

## [Fitur 1]

### Cara Membuat [Item]

1. Masuk ke menu **[Nama Menu]**
2. Klik **Create**

    ![Create](create-item.png)

3. Isi field berikut:

    | Field | Keterangan |
    |-------|------------|
    | Nama  | Nama item  |
    | Kode  | Kode unik  |

4. Klik **Save**

!!! tip "Tips"

    Informasi tambahan yang berguna.