16
Slate API Docs Generator
Seçenek listesi - API'niz için güzel statik belgeler.
- Ücretsiz
- Self-Hosted
- Mac
- Linux
Seçenek listesi - API'niz için güzel statik belgeler.Özellikler Temiz, sezgisel tasarım - Slate ile API'nizin açıklaması belgelerinizin sol tarafında ve tüm kod örnekleri sağ tarafta.Stripe ve Paypal'ın API belgelerinden esinlenmiştir.Arduvaz duyarlı, bu yüzden tabletlerde, telefonlarda ve hatta baskıda harika görünüyor.Her şey tek bir sayfada - Kullanıcılarınızın istediklerini bulmak için milyonlarca sayfada arama yapmaları gereken günler geride kaldı.Seçenek listesi, tüm belgeleri tek bir sayfaya yerleştirir.Bununla birlikte, bağlanabilirlikten ödün vermedik.Siz kaydırdıkça, tarayıcınızın karması en yakın başlığa güncellenir, bu nedenle belgelerdeki belirli bir noktaya bağlantı yapmak doğal ve kolaydır.Slate sadece Markdown - Slate ile dokümanlar yazdığınızda, sadece Markdown'u yazıyorsunuz, bu da düzenlemeyi ve anlamayı kolaylaştırıyor.Her şey Markdown'da yazılmıştır - kod örnekleri bile sadece Markdown kod bloklarıdır.Kod örneklerini birden çok dilde yazma - API'nizde birden çok programlama dilinde bağlamalar varsa, aralarında geçiş yapmak için kolayca sekmeler koyabilirsiniz.Belgenizde, Github Aromalı İşaretleme'de olduğu gibi, her kod bloğunun üstünde dil adını belirterek farklı dilleri ayırt edeceksiniz.Neredeyse 60 dilde kullanıma hazır sözdizimi vurgulama, yapılandırma gerekmez.Sayfanın en solunda bulunan otomatik, akıcı kaydırma.Siz kaydırdıkça, belgedeki geçerli konumunuzu görüntüler.Hızlı da.İçindekilerimizin 180'den fazla girişi olan yeni API'mız için dokümantasyon oluşturmak için TripIt'ta Slate'i kullanıyoruz.Büyük belgeler için bile performansın mükemmel kaldığından emin olduk.
slate-api-docs-generator