xyd

xyd adalah kerangka kerja dokumentasi yang memungkinkan Anda membuat situs web dokumentasi profesional tanpa harus berurusan dengan alat yang rumit. Ini dilengkapi dengan enam tema bawaan yang indah yang dapat Anda gunakan segera, atau Anda dapat menyesuaikan setiap bagian agar sesuai dengan merek Anda. Kerangka kerja ini secara otomatis menghasilkan dokumentasi dari spesifikasi kode OpenAPI, GraphQL, TypeScript, dan React Anda.

Berbeda dengan alat dokumentasi lainnya, xyd mencakup semua yang Anda butuhkan sejak awal. Anda mendapatkan pencarian teks penuh dengan saran cerdas, analitik bawaan untuk melacak bagaimana orang menggunakan dokumen Anda, integrasi obrolan langsung, dan bahkan kemampuan pengujian A/B. Server pengembangan mulai secara instan dengan pemuatan ulang cepat, sehingga Anda melihat perubahan secara langsung. Dibuat oleh pengembang untuk pengembang, xyd menghilangkan bagian membosankan dalam pembuatan dokumentasi sehingga Anda dapat fokus menulis konten yang hebat.

Memulai dengan xyd sangat mudah. Berikut adalah langkah-langkah untuk membuat dokumentasi Anda:

• Pasang xyd secara global menggunakan perintah bun add -g xyd-js atau manajer paket pilihan Anda. Anda perlu menginstal Node.js versi 22.12 atau lebih tinggi di komputer Anda.

• Jalankan xyd di folder proyek Anda untuk memulai server pengembangan. Server ini langsung berjalan dengan hot reload, artinya Anda dapat melihat perubahan secara langsung tanpa perlu memulai ulang.

• Pilih dari enam tema bawaan atau buat desain kustom Anda sendiri. Setiap tema menawarkan gaya dan tata letak yang berbeda sesuai kebutuhan proyek Anda.

• Tulis dokumentasi Anda menggunakan kerangka konten kaya yang mendukung komponen interaktif, contoh kode langsung, dan elemen dinamis yang membuat dokumentasi Anda lebih menarik.

• Untuk dokumentasi API, cukup arahkan xyd ke spesifikasi OpenAPI, GraphQL, TypeScript, atau React Anda dan secara otomatis akan menghasilkan dokumentasi yang indah.

• Jalankan xyd build saat siap untuk membuat file statis yang dapat dideploy ke layanan hosting mana pun.

• Enam tema bawaan yang indah tersedia

• Dokumentasi API otomatis dari OpenAPI, GraphQL, TypeScript, React

• Server pengembangan hot reload tanpa konfigurasi

• Kustomisasi penuh semua komponen dan tata letak

• Ekosistem plugin kaya untuk pencarian, analitik, obrolan

• Contoh kode interaktif dan konten dinamis

• Dukungan analitik bawaan dan pengujian A/B

• Fungsi pencarian teks lengkap yang sangat cepat

• Sumber terbuka dan sepenuhnya gratis

• Alat migrasi dari kerangka kerja lain