Saya mengenal format dokumen markdown sekitar 2 tahun lalu dan mulai aktif menggunakannya sekitar setahun lalu. Bahkan hampir 3 bulan saya menulis draft dan post pada blog ini kebanyakan menggunakan plugin markdown. Hari ini saya akan sedikit berbagi tentang setup dan kumpulan tool yang saya gunakan untuk menulis dokumen dengan format markdown. Mulai dari editor teks, penampil / viewer, tool konversi / konverter.
Mengapa memilih format markdown ?
Berikut adalah beberapa alasan mengapa saya memilih dan sering menulis dengan format markdown.
-
Mudah untuk dipelajari.
Format dan syntax markdown cukup mudah untuk dipelajari dan diingat. Setidaknya untuk beberapa yang sering saya gunakan, misalnya :
- Bold / teks tebal, bisa dengan tanda bintang ganda (** ‘teks’ **).
- Italic / teks miring, bisa dengan tanda underscore / garis bawah ganda (_ ‘teks’ _).
-
Mudah ditulis pada teks editor manapun.
Mulai dari teks editor sederhana seperti
VIM
,nano
, dan teks editor lain yang punya fitur lengkap dan kompleks. -
Portabilitas berkas.
Dokumen markdown bisa ditulis di satu tempat lalu dilanjutkan di tempat lain. Bisa juga dari satu teks editor ke teks editor yang lain. Tanpa ada perubahan bentuk dan format.
-
Dapat dikonversi ke format yang lain.
Setup Sederhana untuk Menulis Dokumen Markdown.
Berikut ini adalah beberapa setup dan kumpulan tool yang saya gunakan.
Teks editor.
Untuk teks editor saya memiliki dua favorit teks editor, berikut ini adalah di antaranya :
-
VIM
.VIM
mulai menjadi teks editor favorit semenjak tahun 2019-an. Mulai dari saya gunakan sebagai notes / catatan kecil, belajar menulis kode dan untuk menulis dokumen markdown. Untuk konfigurasi tidak ada yang spesial / tidak ada yang saya tambahi secara khusus. Walaupun begitu, syntax dari markdown sudah mendapat highlight (teks tebal terlihat tebal, miring terlihat miring, dll), jadi lebih terlihat jelas.
Menulis dokumen markdown menggunakan VIM.
-
Ghostwriter
.Ghostwriter
menjadi editor teks ke dua sebagai favorit untuk menulis dokumen markdown. Sebenarnya saya sudah sangat jarang menggunakannya. Fitur yang saya sukai adalah tampilan langsung / live preview dan fitur konversinya. Berikut adalah sedikit tangkapan gambar dariGhostwriter
.
Tampilan editor (kiri) dan live preview (kanan).
Fitur export untuk mengkonversi dokumen markdown.
Hasil konversi dokumen markdown ke pdf menggunakan ghostwriter.
Penampil / viewer.
Untuk penampil / viewer, saya memiliki satu favorit yaitu tool mdo
. Tool mdo
berjalan di terminal dan berfungsi sebagai penampil dokumen markdown di terminal. Saya sering menggabungkannya dengan terminal vim dan jendela split untuk mendapatkan sensasi tampilan langsung / live preview. Contohnya gambarannya seperti di bawah ini.
Keterangan : sebelah kiri adalah jendela VIM yang berisi dokumen markdown dan sebelah kanan adalah jendela terminal yang sedang menjalankan mdo
untuk menampilkan dokumen markdown.
Tool mdo
bisa dipasang melalui paket manajer python / pip
.
$ pip install --user mdo
Konverter.
Kadang saya perlu mengubah format dokumen markdown menjadi berkas yang bisa dilihat dan dibaca oleh orang lain, misalnya format pdf. Untuk melakukan hal itu, saya membutuhkan konverter, nah… untuk konverter saya menggunakan tool pandoc
. Tool pandoc
bisa kita gunakan untuk mengkonversi dokumen markdown menjadi format lainnya, misalnya pdf.
Sebagai contoh, saya ingin mengkonversi berkas dokumen markdown menjadi format pdf, perintahnya cukup sederhana yaitu :
$ pandoc ~/Documents/markdown.md -o ~/Documents/markdown.pdf
Code language: JavaScript (javascript)
Berikut adalah contoh hasil konversinya.
Mungkin jika sudah diatur bagian marginnya, tampilannya akan jauh lebih baik.
Ringkasan.
Setup untuk menulis dokumen markdown yang saya bagikan di antaranya :
- Teks editor :
VIM
danGhostwriter
. - Penampil / viewer :
mdo
. - Konverter :
pandoc
.
Referensi dan kredit.
- Tutorial mengkonversi markdown menjadi pdf oleh dcchambers.
- Referensi alasan menggunakan markdown.
Penutup.
Demikian tadi setup dan tool untuk menulis dokumen markdown yang bisa saya bagikan. Semoga bisa menjadi referensi dan sebagainya. Semoga bermanfaat juga, terima kasih dan selamat berjumpa pada bahasan selanjutnya !
Leave a Reply