20230429 08h04m54s grim

Membuat Manual Page dari Dokumen Markdown.

Ketika ingin membaca dokumentasi tentang sesuatu (misal tool), kita sering menggunakan perintah man nama_tool. Berkas manual page / halaman manual yang dibaca oleh man biasanya berekstensi ".1" (misal hello.1). Menulis manual page dari awal dengan format bawaannya agak merepotkan. Tapi jika kamu sudah memulai mendokumentasikan / menulis manual page menggunakan format markdown, kamu hanya perlu mengubah / mengkonversi ke format manual page (.1) dengan pandoc. Hari ini kita akan sedikit membahas tentang pembuatan manual page dari dokumen markdown.

Menulis manual page dari awal, kenapa tidak ?

Sempat saya singgung di atas, menulis manual page dari awal mungkin cukup merepotkan. Kita perlu menulis dengan format yang lebih sulit dan mungkin lebih repot dari markdown. Ada satu anggapan jika menulis dokumentasi itu sudah cukup melelahkan, ditambah lagi masih perlu bergelut dengan format penulisan. Oleh karena itu, akan lebih mudah jika kita menulis dengan format markdown lalu hanya perlu mengkonversinya ke format manual page.

Persiapan.

Untuk membuat manual page dari dokumen markdown, berikut adalah beberapa hal yang perlu dipersiapkan.

  • Dokumen markdown.
  • Tool pandoc, untuk mengkonversi dokumen markdown ke format manual page.
  • Tool man, untuk mengecek dan melihat hasil konversi.

Membuat manual page dari dokumen markdown.

Setelah persiapan telah selesai, kita bisa langsung masuk tahap pembuatan manual page. Berikut adalah langkah-langkahnya :

  1. Masuk ke direktori tempat dokumen markdown berada, sebagai contoh di $HOME/Documents.
$ cd $HOME/Documents
  1. Konversi dokumen markdown ke format manual page.

Kita bisa langsung mengkonversi dokumen markdown ke format manual page dengan pandoc. Perintahnya adalah sebagai berikut :

$ pandoc --standalone --to man hello.md -o hello.1
  1. Mengecek hasil konversi dengan man.

Setelah terkonversi, kita bisa mengecek hasil konversi dengan tool man. Perintahnya adalah sebagai berikut :

$ man -l hello.1

Berikut adalah contoh dokumen markdown ( kiri ) yang dikonversi ke format manual page ( kanan ).

20230429 08h04m54s grim

Artikel Terkait

Leave a Reply

Your email address will not be published. Required fields are marked *