Slate API Docs Generator

Slate API Docs Generator

Slate - dokumentasi statik yang indah untuk API anda
Slate - dokumentasi statik yang indah untuk API anda.Ciri Reka bentuk yang bersih, intuitif - Dengan Slate, keterangan API anda berada di sebelah kiri dokumentasi anda, dan semua contoh kod di sebelah kanan.Diilhamkan oleh dokumen API Stripe dan Paypal.Slate responsif, jadi ia kelihatan hebat pada tablet, telefon, dan juga dalam cetakan.Segala-galanya pada satu halaman - Pergi adalah hari-hari apabila pengguna anda perlu mencari satu juta halaman untuk mencari apa yang mereka mahu.Slate meletakkan keseluruhan dokumentasi pada satu halaman.Walaupun kami tidak mengorbankan hubungan, namun.Seperti yang anda tatal, hash penyemak imbas anda akan dikemas kini ke tajuk yang terdekat, jadi menghubungkan ke titik tertentu dalam dokumentasi masih asli dan mudah.Slate hanya Markdown - Apabila anda menulis dokumen dengan Slate, anda hanya menulis Markdown, yang menjadikannya mudah untuk diedit dan difahami.Segala-galanya ditulis dalam Markdown - walaupun contoh kod itu hanya blok Kod penurunan harga.Menulis contoh kod dalam pelbagai bahasa - Jika API anda mempunyai pengikatan dalam pelbagai bahasa pengaturcaraan, anda boleh dengan mudah memasukkan tab untuk bertukar di antara mereka.Dalam dokumen anda, anda akan membezakan bahasa yang berbeza dengan menyatakan nama bahasa di bahagian atas setiap blok kod, sama seperti Github Flavored Markdown.Sintaks luar kotak yang menyerlahkan untuk hampir 60 bahasa, tiada konfigurasi diperlukan.Jadual automatik, lancar menatal kandungan di sebelah kiri halaman.Seperti yang anda tatal, ia memaparkan kedudukan semasa anda dalam dokumen itu.Ia juga pantas.Kami menggunakan Slate di TripIt untuk membina dokumentasi untuk API baharu kami, di mana jadual kandungan kami mempunyai lebih daripada 180 entri.Kami telah memastikan bahawa prestasi tetap cemerlang, walaupun untuk dokumen yang lebih besar.
slate-api-docs-generator

Kategori

Alternatif untuk Slate API Docs Generator untuk semua platform dengan sebarang lesen

Javadoc

Javadoc

Javadoc adalah alat dari Sun Microsystems untuk menghasilkan dokumentasi API dalam format HTML dari ulasan doc dalam kod sumber.
EDoC++

EDoC++

EDoC ++ adalah alat analisis sumber C ++ yang direka untuk mengenal pasti masalah yang berkaitan dengan penggunaan pengecualian dalam kod C ++.
LuaDoc

LuaDoc

LuaDoc adalah alat penjana dokumentasi untuk ...
LDoc

LDoc

LDoc adalah ...
Doc-O-Matic

Doc-O-Matic

Doc-O-Matic adalah dokumentasi kod sumber perisian dan Alat pengarang bantuan.
DapperDox

DapperDox

Penjana dokumentasi API dan sumber terbuka untuk spesifikasi OpenAPI Swagger.
ForgeDoc

ForgeDoc

ForgeDoc adalah penjana dokumentasi perpustakaan kelas untuk perhimpunan NET.Ia boleh membuat dokumentasi rujukan API gaya MSDN dalam format output HTML dan CHM.
sharpDox

sharpDox

sharpDox adalah alat dokumentasi untuk membuat dokumentasi kod # c apa-apa jenis.Alat ini membuat model penyelesaian c # yang diberikan dan melaluinya kepada plugin eksport berdaftar.