Create Project¶

🚀 Get Started¶

Setelah MkDocs berhasil diinstal, langkah berikutnya adalah membuat project dokumentasi baru. Pada panduan ini, Anda akan membuat project MkDocs, menjalankan development server, serta membangun website statis pertama menggunakan MkDocs.

🎯 Learning Objectives¶

Setelah menyelesaikan panduan ini, Anda akan mampu:

Membuat project MkDocs baru.
Memahami struktur project awal.
Menjalankan development server.
Menggunakan fitur Live Reload.
Membangun website statis.

🔄 Workflow¶

flowchart LR

    A["Create Project"]
        --> B["Review Project Structure"]

    B --> C["Start Development Server"]

    C --> D["Build Website"]

    D --> E["Project Ready"]

📋 Prerequisites¶

Pastikan beberapa kebutuhan berikut telah tersedia.

Component	Description
MkDocs	Telah terinstal
Material for MkDocs	Telah terinstal
Python Virtual Environment	Sudah diaktifkan
Terminal	Bash atau shell lainnya

▶️ Procedure¶

Create a New Project¶

Pindah ke direktori kerja.

cd ~/git

Buat project baru.

mkdocs new my-project

Contoh output.

INFO    - Creating project directory: my-project
INFO    - Writing config file: my-project/mkdocs.yml
INFO    - Writing initial docs: my-project/docs/index.md

Review Project Structure¶

Masuk ke direktori project.

cd my-project

Lihat struktur project.

tree

Contoh output.

my-project/
├── docs/
│   └── index.md
└── mkdocs.yml

Keterangan.

File / Directory	Description
`docs/`	Menyimpan seluruh dokumentasi Markdown.
`docs/index.md`	Halaman utama website.
`mkdocs.yml`	File konfigurasi MkDocs.

Start the Development Server¶

Jalankan development server.

mkdocs serve

Secara default website tersedia pada.

http://127.0.0.1:8000

Apabila ingin dapat diakses dari perangkat lain dalam jaringan yang sama.

mkdocs serve --dev-addr 0.0.0.0:8000

Test Live Reload¶

Buka file berikut.

docs/index.md

Tambahkan beberapa perubahan.

Simpan file kemudian refresh browser.

MkDocs akan secara otomatis melakukan rebuild tanpa perlu menjalankan ulang development server.

Build the Website¶

Bangun website statis.

mkdocs build

Direktori baru akan dibuat.

my-project/
├── docs/
├── site/
└── mkdocs.yml

Direktori site/ berisi website statis yang siap dipublikasikan.

✅ Verification¶

Pastikan struktur project telah dibuat.

tree

Pastikan development server berjalan.

mkdocs serve

Akses website.

http://127.0.0.1:8000

Selanjutnya lakukan build.

mkdocs build

Pastikan direktori berikut tersedia.

site/

Verification

Project dinyatakan berhasil apabila:

Project berhasil dibuat.
Development server berjalan tanpa error.
Website dapat diakses melalui browser.
Live Reload berfungsi.
Direktori site/ berhasil dibuat.

💡 Technology Notes¶

MkDocs secara otomatis membuat struktur project minimal yang siap digunakan.
Development server mendukung Live Reload, sehingga perubahan dokumentasi langsung terlihat tanpa perlu menjalankan ulang server.
Direktori site/ merupakan hasil proses build dan akan dibuat ulang setiap kali menjalankan mkdocs build.

▶️ Next Steps¶

Project MkDocs sekarang telah siap digunakan.

Tahap berikutnya adalah mempelajari struktur direktori dan fungsi setiap file yang digunakan selama pengembangan dokumentasi.

Document	Description
Project Structure	Memahami struktur project MkDocs.
Configuration	Mengonfigurasi website menggunakan `mkdocs.yml`.

📝 Summary¶

Pada panduan ini Anda telah mempelajari cara:

Membuat project MkDocs baru.
Memahami struktur project awal.
Menjalankan development server.
Menggunakan fitur Live Reload.
Membangun website statis menggunakan mkdocs build.

Project sekarang siap digunakan untuk menulis dokumentasi.