xyd

xyd, karmaşık araçlarla uğraşmadan profesyonel dokümantasyon web siteleri oluşturmanızı sağlayan bir dokümantasyon çerçevesidir. Hemen kullanabileceğiniz altı güzel yerleşik tema ile birlikte gelir veya markanıza uyacak şekilde her kısmı özelleştirebilirsiniz. Çerçeve, OpenAPI, GraphQL, TypeScript ve React kod spesifikasyonlarınızdan otomatik olarak dokümantasyon oluşturur.

Diğer dokümantasyon araçlarının aksine, xyd baştan ihtiyacınız olan her şeyi içerir. Akıllı önerilerle tam metin arama, kullanıcıların dokümanlarınızı nasıl kullandığını takip etmek için yerleşik analizler, canlı sohbet entegrasyonu ve hatta A/B test yetenekleri elde edersiniz. Geliştirme sunucusu, sıcak yeniden yükleme ile anında başlar, böylece değişiklikleri hemen görürsünüz. Geliştiriciler tarafından geliştiriciler için oluşturulan xyd, dokümantasyon yapmanın sıkıcı kısımlarını ortadan kaldırır, böylece harika içerik yazmaya odaklanabilirsiniz.

xyd ile başlaması oldukça basittir. İşte dokümantasyonunuzu oluşturmak için adımlar:

• bun add -g xyd-js komutunu veya tercih ettiğiniz paket yöneticisini kullanarak xyd'yi global olarak kurun. Bilgisayarınızda Node.js sürüm 22.12 veya daha yüksek bir sürümün yüklü olması gerekmektedir.

• Geliştirme sunucusunu başlatmak için proje klasörünüzde xyd komutunu çalıştırın. Sıcak yeniden yükleme ile anında başlar, yani değişikliklerinizi yeniden başlatmadan hemen görebilirsiniz.

• Altı yerleşik temadan birini seçin veya kendi özel tasarımınızı oluşturun. Her tema, projenizin ihtiyaçlarına uygun farklı bir stil ve düzen sunar.

• Dokümantasyonunuzu, etkileşimli bileşenleri, canlı kod örneklerini ve dokümanlarınızı daha ilgi çekici hale getiren dinamik öğeleri destekleyen zengin içerik çerçevesi kullanarak yazın.

• API dokümantasyonu için, xyd'yi OpenAPI, GraphQL, TypeScript veya React spesifikasyonlarınıza yönlendirin; otomatik olarak güzel dokümantasyon oluşturur.

• Yayınlama için statik dosyalar oluşturmak istediğinizde xyd build komutunu çalıştırın.

• Altı güzel yerleşik tema mevcut

• OpenAPI, GraphQL, TypeScript, React'ten otomatik API dokümantasyonu

• Sıfır yapılandırmayla sıcak yeniden yükleme geliştirme sunucusu

• Tüm bileşenlerin ve düzenlerin tam özelleştirilmesi

• Arama, analiz, sohbet için zengin eklenti ekosistemi

• Etkileşimli kod örnekleri ve dinamik içerik

• Yerleşik analiz ve A/B testi desteği

• Yıldırım hızında tam metin arama işlevi

• Açık kaynak ve tamamen ücretsiz

• Diğer çerçevelerden geçiş araçları