Hasilkan Dokumentasi dengan File Penurunan Harga Menggunakan Docsify

Jika Anda membuat plugin, kerangka kerja, atau skrip open-source gratis Anda akan memerlukan dokumentasi. Ini penting untuk dokumentasikan pekerjaan Anda, baik untuk kewarasan Anda dan untuk membantu orang lain yang ingin mempelajari sumber daya luar biasa Anda.

Namun, membuat dokumentasi online bisa sangat menyebalkan. Untungnya, Dokumentasikan membuatnya lebih mudah dengan menyediakan a generator dokumentasi gratis berjalan pada penurunan harga.

Ini adalah bukan generator situs statis yang khas dan itu terjadi tidak memerlukan halaman HTML / CSS statis. Sebaliknya, itu memuat file Penurunan harga secara dinamis dan menampilkannya sebagai halaman web. Cukup rapi!

Lihat beranda Docsify untuk a pratinjau tata letak, bersama perincian pengaturan lebih lanjut.

Itu mengharuskan Anda buat sendiri file index.html, yang kemudian dapat diunggah ke Halaman GitHub atau di-host di server Anda sendiri. Dari sana, Anda baru saja tulis file Penurunan harga untuk setiap halaman dan gunakan itu sebagai dokumen utama Anda.

Seluruh proses diuraikan secara rinci dalam panduan mulai cepat, jadi itu mungkin tempat terbaik untuk memulai. Ini bisa semua dijalankan melalui npm, jadi sangat membantu untuk mengetahui command prompt Anda atau setidaknya mau belajar.

Dimungkinkan untuk membuat sendiri file HTML mentah dan cukup salin / tempel templat dari panduan penyiapan Docsify. Tapi saya sarankan melakukannya secara dinamis, karena menghemat banyak waktu - dan bukankah itu intinya?

Ketika Anda mempelajari sistem Docsify, Anda bisa tambahkan fitur menggunakan Markdown atau HTML mentah. Fitur-fitur ini termasuk a bilah navigasi khusus dan bahkan halaman sampul Anda sendiri dengan logo proyek Anda.

Dokumentasikan bahkan hadir dikemas dengan banyak tema gratis jika Anda ingin tata letak pra-desain bekerja dengan. Atau kamu bisa telusuri galeri showcase mereka untuk melihat proyek mana yang menggunakan Docsify untuk dokumentasi mereka.

Semua info pengaturan dasar & unduhan file dapat ditemukan di GitHub, jadi pergilah ke sana jika Anda ingin mencobanya.

Anda juga bisa lihat demo langsung di halaman dokumentasi Docsify utama yang, tentu saja, berjalan pada Docsify. Jadi, jika Anda suka tata letak halaman web itu, Anda dapat menggunakan templat yang sama dan menjalankan semuanya melalui Docsify, 100% gratis dan sumber terbuka.