Docusaurus, belgelerinizi build/ içinde statik bir siteye dönüştürür: her belge ve her blog yazısı HTML olarak, tarayıcıda çalışan arama ve gezinmeyle. Lobsite bu klasörü barındırır. npm run build, ardından npx lobsite çalıştırın; belgeleriniz HTTPS'li bir *.lobsite.app adresinde yayında olur. Her deploy'un ayrıca kendi URL'si vardır; belge değişikliklerini yayına girmeden önce incelemek için kullanışlıdır.
Nasıl çalışır
- Belgeleri
npm run buildile derleyin. Docusaurus siteyibuild/içine yazar ve varsayılan olarak bozuk bağlantılarda derlemeyi başarısız sayar. - Projede
npx lobsiteçalıştırın.static/klasörünü değil,build/klasörünü deploy eder. İlk deploy hesap gerektirmez ve 6 saat sürer. - Siteyi sahiplenme bağlantısıyla ücretsiz bir hesapta koruyun. Sonrasında
npm run build && npx lobsiteaynı adresi günceller.
url, baseUrl ve sondaki eğik çizgiler
// docusaurus.config.js
export default {
url: "https://my-docs.lobsite.app",
baseUrl: "/",
};
url, sitenizin adresidir. Docusaurus bunu kanonik bağlantılar ve site haritası için kullanır.baseUrl, Lobsite'ta/olur. Bir GitHub Pages proje sitesi/repo-name/kullanır; bunu bırakmak tüm varlık bağlantılarını bozar.trailingSlashbelirtilmeyebilir.docs/intro/index.htmlolarak derlenen belgeler/docs/intro/adresinde açılır;/docs/introoraya yönlendirir.
Belge değişikliklerini inceleme
Belgeleri birçok kişi yazar ve çoğu zaman başka biri inceler. lobsite deploy --preview, yayındaki belgelere dokunmadan derlemeyi kendi URL'sinde yayımlar; inceleyen kişi değişikliği görüneceği haliyle okur. lobsite promote onu yayına alır, lobsite rollback ise tek adımda önceki sürüme döner. Sayfaların yerini mi değiştiriyorsunuz? Arama sonuçlarından ve diğer sitelerden gelen bağlantıların çalışmaya devam etmesi için eski yolların yönlendirmelerini lobsite.toml dosyasına ekleyin; kuralları Yönlendirme Oluşturucu yazar. Yapay zekâ kodlama ajanları aynı deploy'u, hiçbir zaman soru sormak için durmayan npx -y lobsite --yes ile çalıştırabilir.
Yayına almadan önce önizleyin. Yönlendirmeler dahil tek tıkla geri alın.
Dosyalar hash'lerine göre saklanır. Değişmemiş bir siteyi yeniden deploy etmek 0 bayt yükler.
Her site ilk deploy'dan itibaren HTTPS'li bir *.lobsite.app adresi alır.
Yönlendirmeler, başlıklar ve formlar lobsite.toml içinde durur ve her deploy ile birlikte gider.
Bir ajan altında soru sorulmaz; URL ve sahiplenme bağlantısını içeren bir Tell the user: satırı verilir.
Her sınır yayımlanmıştır ve her hata sonra ne yapmanız gerektiğini söyler.
Docusaurus barındırma hizmetleri karşılaştırması
| Lobsite | GitHub Pages | Netlify | Vercel | |
|---|---|---|---|---|
| Belgeleri sizin için derler | Hayır: build/ klasörünü deploy edersiniz |
GitHub Actions içinde veya docusaurus deploy |
Evet | Evet |
| Her deploy için önizleme URL'si | Evet | Hayır | Evet | Evet |
| Tek adımda geri alma | Evet | Bir commit'i geri almak | Evet | Evet |
| İlk deploy'dan önce hesap | Hayır: 6 saat yayında, sonra ücretsiz koruyun | Evet, ve bir depo | Evet | Evet |
| Özel alan adı | Evet, ücretsiz | Evet, ücretsiz | Evet | Evet |
GitHub Pages, kodun yanında duran açık kaynak belgeler için iyi çalışır. Lobsite ise yerelde veya CI'da derlediğiniz ve barındırmanın etrafında bir Git iş akışı olmadan önizlemek, yayına almak ve geri almak istediğiniz belgeler için uygundur.
Sık sorulan sorular
Docusaurus, Lobsite'ta hangi baseUrl'yi kullanmalı?
/. Site, adresinin kökünden sunulur. Yalnızca bir GitHub Pages proje sitesi /repo-name/ gerektirir.
Docusaurus araması statik bir barındırmada çalışır mı?
Evet. Algolia DocSearch ziyaretçinin tarayıcısında çalışır, yerel arama eklentileri de dizinlerini build/ içine derler. İkisi de sunucu gerektirmez.
Sürümlü Docusaurus belgelerini barındırabilir miyim?
Evet. Her sürüm build/ içinde kendi sayfaları olarak derlenir, bu yüzden hepsi birlikte deploy edilir. Yalnızca son deploy'dan beri değişen dosyalar yüklenir.
Bir Docusaurus sitesi ne kadar büyük olabilir?
Ücretsiz planda deploy başına 100 dosyaya ve 50 MB'a kadar; bu, çoğu belge sitesine yeter. Çok sürümlü veya çok görselli daha büyük belgeler, yakında gelecek ücretli planı gerektirir; tüm sınırlar sınırlar tablosundadır.