Membuat Dokumentasi dengan MkDocs

Bila anda terbiasa menggunakan markdown untuk menulis dokumentasi, pindah ke MkDocs untuk menggenerate halaman dokumentasi menjadi sangat mudah. Keuntungan menggunakan mkdocs ini, semua folder yang ada dibuat menjadi sub-menu yang memudahkan navigasinya di halaman web. Satu lagi fitur yang ngga kalah pentingnya dari static site generator ini adalah pencarian (searching).

Install MkDocs

dnf install mkdocs

Konfigurasi

Untuk membuat project baru, kita perlu menggunakan perintah mkdocs new, bila sudah terbiasa kedepannya tinggal membuat file mkdocs.yml

mkdocs new dokumentasi

pindah ke folder dokumentasi, lalu jalankan build-in server mkdocs

cd dokumentasi
mkdocs serve

Di browser buka http://127.0.0.1:8000/

Bila anda ingin mengcopy file websiter tersebut ke misalkan github, gitlab atau cpanel, build terlebih dahulu, agar mkdocs membuat folder baru bernama site lengkap dengan file-file yang bisa dicopy

mkdocs build

Copy semua file yang berada di folder dokumentasi/site.