Neden var
CMS tarafından yönetilen içeriğin, oluşturma katmanını yeniden inşa etmeden cilalı bir dokümantasyon sitesine dönüştürülebileceğini kanıtlayan, dokümantasyona odaklı bir uygulama sunuyoruz.
Ne zaman kullanılmalı
- CMS içeriğinin üzerine ürün dokümantasyonunu barındırmak
- markdown ağırlıklı belgeleri işlemek
- kenar çubuğu ve arama odaklı dokümantasyon gezinmesi oluşturmak
Neler içerir
- docs-template Next.js uygulaması
- CMS destekli catch-all rota işleme
- dokümantasyon markdown sınırı
- dokümantasyona özel gezinme çubuğu, kenar çubuğu ve içerik bileşenleri
- dil farkındalığına sahip yazı ve kategori yükleme
Temel iş akışı
- Dokümantasyon uygulamasını CMS ortam değişkenleriyle yapılandırın.
cms-renderer aracılığıyla dokümantasyon rotalarını render edin.- CMS şemalarından kategori ve yazı dokümanlarını alın.
- Markdown içeriğini dokümantasyona özel bileşenlerle render edin.
- Üstüne daha zengin gezinme ve arama katmanları ekleyin.
Sistem yüzeyleri
- dokümantasyon uygulaması rota katmanı
- dokümantasyon kullanıcı arayüzü bileşen katmanı
- dokümantasyon CMS veri ve URL yardımcıları