Docusaurus: Alat yang sangat baik untuk mendokumentasikan projek

Salah satu tugas yang paling penting ketika membuat perisian adalah dokumentasi, malangnya bagi kita yang mengembangkan karya ini kadang-kadang kelihatan membosankan, tetapi bukan rahsia bagi siapa pun bahawa dokumentasi yang baik dapat menjadi titik kejayaan alat apa pun, kerana Baik untuk pertolongan yang diberikan kepada pengguna untuk memahami operasi aplikasi yang betul atau maklumat yang diberikan kepada pembangun lain untuk memperbaikinya.

Terdapat aplikasi yang cukup baik yang membolehkan kami mendokumentasikan projek kami dengan cara yang mudah, ada yang cenderung menawarkan lebih banyak daripada yang sebenarnya kami mahukan dan yang lain memerlukan pemasangan yang kompleks, alat untuk mendokumentasikan projek yang mematuhi dan agak mudah digunakan dan dipasang adalah Docusaurus.

Apa itu Docusaurus?

Docusaurus adalah projek untuk membina, melaksanakan, dan menyelenggara dokumentasi web alat sumber terbuka, ia memungkinkan untuk menggunakan bahasa Penurunan harga Untuk menulis dokumentasi yang kemudiannya akan diterbitkan sebagai laman web html, dengan cara yang sama, alat ini membolehkan kami memperluas dan menyesuaikan reka bentuk laman web dokumentasi kami dengan penggunaan React.

Secara umum, alat sumber terbuka ini yang dikembangkan oleh pasukan pengaturcaraan Facebook membolehkan kami membuat laman web yang cantik dan ringan di mana kami dapat memaparkan dokumentasi projek apa pun dengan betul.

Alat ini dilengkapi dengan fungsi untuk memformat dokumen yang betul, enjin carian lanjutan, kemungkinan mendokumentasikan dan mendesain semula laman web dokumentasi kami dalam masa nyata, penyatuan dengan terjemahan dan banyak lagi ciri lain yang akan membantu anda lebih sedikit bimbang tentang pendokumentasian atau lebih tepatnya untuk membuat proses dokumentasi lebih mudah dan dengan kemasan yang lebih menyenangkan.

Penggunaan Docusaurus yang mudah dapat dilihat pada gif berikut yang diedarkan oleh pembangunnya

Bagaimana cara memasang Docusaurus?

Objektif utama Docusaurus adalah menjadi alat yang pasti untuk mendokumentasikan aplikasi sumber terbuka yang dihoskan di github, jadi sangat mudah untuk memasang dan menjalankan laman web dokumentasi anda di platform ini.

Untuk mula menikmati Docusaurus di Github, ikuti langkah-langkah yang ditunjukkan oleh pasukan pembangunan dan yang kami petik di bawah:

  1. Pergi ke root direktori repositori GitHub anda di mana anda akan membuat dokumen dan menjalankan perintah berikut:
  2. yarn global add docusaurus-init or npm install --global docusaurus-init
  3. docusaurus-init

Hasil akhirnya adalah penciptaan struktur fail dan direktori seperti gambar di bawah:

alat untuk mendokumentasikan projek


Komen, tinggalkan komen anda

Tinggalkan komen anda

Alamat email anda tidak akan disiarkan. Ruangan yang diperlukan ditanda dengan *

*

*

  1. Bertanggungjawab atas data: Miguel Ángel Gatón
  2. Tujuan data: Mengendalikan SPAM, pengurusan komen.
  3. Perundangan: Persetujuan anda
  4. Komunikasi data: Data tidak akan disampaikan kepada pihak ketiga kecuali dengan kewajiban hukum.
  5. Penyimpanan data: Pangkalan data yang dihoskan oleh Occentus Networks (EU)
  6. Hak: Pada bila-bila masa anda boleh menghadkan, memulihkan dan menghapus maklumat anda.

  1.   Juan José kata

    Bug yang menarik untuk dicuba!