Membuat Web Dokumentasi dengan MKdocs

Membuat Web Dokumentasi dengan MKdocs – Suatu projek aplikasi memiliki fitur yang dapat digunakan, semakin banyak aplikasinya makin banyak juga fitur yang ada. Fitur pada suatu aplikasi dapat membingungkan tim atau pengguna lain ketika belum memegang kendali penuh terhadap penguasaan software. Panduan web dibedakan menjadi 2 yaitu pengguna dan tim lainnya.

Ada berapa tools yang dapat digunakan untuk membuat dokumentasi aplikasi salah satunya MKdocs. MKdocs merupakan aplikasi berbasis web yang digunakan untuk menuliskan dokumentasi program menggunakan markdown type.

Kode yang dituliskan di MKdocs berupa halaman static template, artinya tidak memilki panel kusus untuk mengelolanya. Mkdocs sendiri berjalan diatas bahasa pemrograman python.

Baca Juga : 5 Aplikasi untuk Desain Grafis di Linux

Membuat Web Dokumentasi dengan MKdocs

Ada beberapa kelebihan menggunakan MKdocs untuk membuat dokumentasi / user guide suatu projek.

Kelebihan menggunakan Tools MKdocs

  • Menggunakan basis markdown dan bahasa python.
  • Mudah untuk digunakan dan strukturnya mudah dipahami.
  • Live Autoreload, sehingga tidak perlu merefresh ulang browser.
  • Didukung menggunakan tempate yang lebih menarik.
  • Dapat di ubah menjadi FIle HTML dan CSS.
  • Dapat di publikasikan di Repo Git, baik gitlab maupun github.

Cara menggunakan MKdocs

Sebelum anda dapat menggunakan MKdocs pastikan komputer anda sudah terinstall python , artinya dapat menjalankan file python dan sudah menginstall pip.

Langsung saja mari kita bahas.

Install Mkdocs

Untuk menginstall mkdocs dapat menggunakan pip, langsung saja ketikkan diterminal dengan perintah.

Membuat Projek Baru

Setelah berhasil install MKdocs selanjutnya kita sudah dapat membuat projek MKDocs baru dengan perintah.

maka output nya adalah

Akan terbuat folder dengan nama projek anda dan terdapat 1 buah file dan folder.

Baca Juga : Tutorial Gin Gonic : Belajar membuat Router pada Gin 

Menjalankan MKdocs

Untuk menjalankan mkdocs agar dapat diakses di halaman browser dengan mengetikan perintah.

dan lihat hasilnya

Kesimpulan

Mkdocs sangat cocok untuk membuat dokumentasi baik program maupun aplikasi untuk semua platform, baik website, dekstop maupun mobile. Susunan dokumentasi dapat dilakukan secara rapi, karena menggunakan markdown yang terstruktur. Dukungan template memungkinkan membuat tampilan lebih menarik.

Sekian cara membuat dokumentasi web dengan mkdocs.

Semoga Bermanfaat.

admin
Leave a Reply