Skip to content

Installation

🚀 Get Started

Sebelum membuat proyek MkDocs, pastikan lingkungan pengembangan telah disiapkan dengan benar.

MkDocs merupakan aplikasi Python yang didistribusikan melalui pip. Oleh karena itu, instalasi dimulai dengan menyiapkan Python, pip, dan virtual environment sebelum menginstal MkDocs beserta dependensinya.

Menggunakan virtual environment direkomendasikan untuk mengisolasi package proyek sehingga tidak memengaruhi instalasi Python pada sistem operasi.

🎯 Learning Objectives

Setelah menyelesaikan panduan ini, Anda akan mampu:

  • Menyiapkan lingkungan pengembangan MkDocs.
  • Memverifikasi instalasi Python dan pip.
  • Membuat Python Virtual Environment.
  • Menginstal MkDocs dan Material for MkDocs.
  • Memverifikasi hasil instalasi.

🔄 Workflow

flowchart LR

    A["Install Python"]
        --> B["Prepare pip"]

    B --> C["Create Virtual Environment"]

    C --> D["Install MkDocs"]

    D --> E["Install Material Theme"]

    E --> F["Verification"]

📋 Prerequisites

Pastikan:

Component Description
Operating System Linux (Ubuntu/Debian Recommended)
Internet Connection Required
Terminal Available

▶️ Procedure

Install Python

Periksa apakah Python telah tersedia.

python3 --version

Contoh output.

Python 3.12.3

Apabila Python belum tersedia, instal menggunakan package manager.

Ubuntu / Debian

sudo apt update
sudo apt install python3 python3-pip python3-venv python3-full -y

Prepare pip

Pastikan pip tersedia dan siap digunakan.

Periksa versi pip.

pip --version

Apabila pip belum tersedia atau ingin memastikan menggunakan versi terbaru yang kompatibel, jalankan:

python3 -m pip install --upgrade pip

Perintah tersebut memastikan pip siap digunakan untuk menginstal package Python lainnya.

Verifikasi.

pip --version

Create Virtual Environment

Buat virtual environment.

python3 -m venv .venv

Aktifkan virtual environment.

Linux

source .venv/bin/activate

Prompt terminal akan berubah.

(.venv) user@hostname:~$

Install MkDocs

Instal MkDocs.

pip install mkdocs

Verifikasi.

mkdocs --version

Contoh output.

mkdocs, version 1.x.x

Install Material for MkDocs

Instal Material Theme.

pip install mkdocs-material

Apabila proyek menggunakan plugin tambahan, instal sesuai kebutuhan.

Contoh.

pip install mkdocs-awesome-pages-plugin

Verifikasi.

pip show mkdocs-material

Verify the Installation

Pastikan seluruh komponen telah tersedia.

python3 --version

pip --version

mkdocs --version

pip show mkdocs-material

✅ Verification

Pastikan:

  • Python berhasil diinstal.
  • pip tersedia dan dapat digunakan.
  • Virtual Environment berhasil dibuat.
  • MkDocs berhasil diinstal.
  • Material for MkDocs berhasil diinstal.

Verification

Instalasi dinyatakan berhasil apabila seluruh komponen dapat dijalankan tanpa error dan siap digunakan untuk membuat proyek MkDocs.

💡 Technology Notes

  • Gunakan Python Virtual Environment untuk setiap proyek.
  • Hindari menginstal package Python secara global kecuali benar-benar diperlukan.
  • Selalu aktifkan virtual environment sebelum menjalankan perintah MkDocs.
  • Pastikan pip berada dalam kondisi siap sebelum menginstal package tambahan.

▶️ Next Steps

Setelah lingkungan pengembangan selesai disiapkan, lanjutkan dengan membuat proyek MkDocs pertama.

Document Description
Create Project Create a new MkDocs project
Project Structure Understand the generated project structure

🌐 External References

📝 Summary

Pada panduan ini Anda telah mempelajari cara:

  • Menyiapkan Python dan pip.
  • Membuat Python Virtual Environment.
  • Menginstal MkDocs.
  • Menginstal Material for MkDocs.
  • Memverifikasi hasil instalasi.

Lingkungan pengembangan sekarang siap digunakan untuk membuat proyek MkDocs.