Salah satu tugas terpenting saat membuat perangkat lunak adalah dokumentasi, sayangnya bagi kita yang mengembangkan pekerjaan ini terkadang tampak membosankan, tetapi bukan rahasia lagi bagi siapa pun bahwa dokumentasi yang baik dapat menjadi titik keberhasilan alat apa pun, karena salah satu dari bantuan yang diberikan kepada pengguna untuk memahami pengoperasian aplikasi yang benar atau informasi yang diberikan kepada pengembang lain untuk memperbaikinya.
Ada aplikasi yang cukup bagus yang memungkinkan kita untuk mendokumentasikan proyek kita dengan cara yang sederhana, beberapa cenderung menawarkan lebih dari apa yang kita inginkan dan yang lainnya membutuhkan instalasi yang rumit, a alat untuk mendokumentasikan proyek yang sesuai dan cukup mudah digunakan dan diinstal adalah Docusaurus.
Apa itu Docusaurus?
Dokusaurus adalah proyek untuk membangun, menerapkan, dan memelihara dokumentasi web alat sumber terbuka, itu memungkinkan untuk menggunakan bahasa Penurunan harga Untuk menulis dokumentasi yang nantinya akan dipublikasikan sebagai situs web html, dengan cara yang sama, alat ini memungkinkan kami untuk memperluas dan menyesuaikan desain situs web dokumentasi kami dengan menggunakan React.
Secara umum, alat sumber terbuka yang dikembangkan oleh tim pemrograman Facebook ini memungkinkan kita untuk dengan mudah membuat situs web yang indah dan ringan tempat kita dapat menampilkan dokumentasi proyek apa pun dengan benar.
Alat ini dilengkapi dengan fungsi untuk membuat versi dokumen yang benar, mesin pencari tingkat lanjut, kemungkinan mendokumentasikan dan mendesain ulang situs dokumentasi kami secara real time, integrasi dengan terjemahan dan banyak fitur lainnya yang akan membantu Anda mengurangi kekhawatiran tentang pendokumentasian atau lebih tepatnya untuk membuatnya. proses dokumentasi lebih mudah dan dengan hasil akhir yang lebih menyenangkan.
Penggunaan Docusaurus yang mudah dapat dilihat pada gif berikut yang didistribusikan oleh pengembangnya
Bagaimana cara menginstal Docusaurus?
Tujuan utama Docusaurus adalah menjadi alat definitif untuk mendokumentasikan aplikasi sumber terbuka yang dihosting di github, jadi sangat mudah untuk menginstal dan menjalankan situs web dokumentasi Anda di platform ini.
Untuk mulai menikmati Docusaurus di Github, cukup ikuti langkah-langkah yang ditunjukkan oleh tim pengembangan dan yang kami kutip di bawah ini:
- Buka root direktori repositori GitHub Anda di mana Anda akan membuat dokumen dan menjalankan perintah berikut:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Hasil akhirnya adalah pembuatan file dan struktur direktori seperti yang ditunjukkan di bawah ini:
Bug yang menarik untuk dicoba!