Hasilkan Dokumentasi dengan Fail Menurun Skrin Menggunakan Docsify

Jika anda mencipta plugin percuma, rangka kerja, atau skrip sumber terbuka anda perlu dokumentasi. Ia penting untuk dokumen kerja anda, baik untuk kewarasan anda dan untuk membantu orang lain yang ingin belajar sumber hebat anda.

Walau bagaimanapun, membuat dokumentasi dalam talian boleh menjadi kesakitan yang sebenar. Syukurlah, Membezakan menjadikannya lebih mudah dengan menyediakan penjana dokumentasi percuma yang dijalankan di Markdown.

Ini adalah bukan penjana tapak statik biasa dan ia berlaku tidak memerlukan halaman HTML / CSS statik. Sebaliknya, ia memuatkan fail Tamat turun dinamik dan memaparkannya sebagai halaman web. Pretty neat!

Lihat laman utama Docsify untuk a pratonton susun atur, bersama dengan butiran persediaan selanjutnya.

Ia memerlukan anda buat fail index.html itu sendiri, yang kemudiannya boleh dimuat naik ke Halaman GitHub atau dihoskan pada pelayan anda sendiri. Dari sana, anda hanya tulis fail Markdown untuk setiap halaman dan gunakan mereka sebagai dokumen utama anda.

Seluruh proses terperinci secara terperinci dalam panduan permulaan cepat, jadi itu mungkin tempat terbaik untuk bermula. Ini boleh semua berjalan melalui npm, jadi ia benar-benar membantu untuk mengetahui arahan arahan anda atau sekurang-kurangnya bersedia untuk belajar.

Anda boleh membuat fail HTML mentah sendiri dan hanya copy / paste templat dari panduan persediaan Docsify. Tetapi, saya cadangkan melakukannya secara dinamik, kerana ia menjimatkan satu tan masa-dan bukannya perkara itu sebenarnya?

Semasa anda mempelajari sistem Docsify, anda boleh tambah ciri menggunakan Markdown atau HTML mentah. Ciri-ciri ini termasuk a bar navigasi tersuai dan juga halaman penutup anda sendiri dengan logo projek anda.

Memodifikasi walaupun datang dibungkus dengan banyak tema percuma jika anda mahu susun atur yang direka bentuk untuk berfungsi dengan baik. Atau, anda boleh semak galeri pameran mereka untuk melihat projek-projek yang menggunakan Docsify untuk dokumentasi mereka.

Semua maklumat persediaan asas & muat turun fail boleh didapati di GitHub, jadi kepala di sana jika anda mahu memberikan pukulan ini.

Anda juga boleh lihat demo langsung pada halaman dokumentasi Dokumen utama yang, cukup pasti, berjalan pada Docsify. Jadi, jika anda suka susun atur laman web yang anda boleh gunakan template yang sama dan jalankan semua melalui Docsify, 100% percuma dan sumber terbuka.