Docusaurus buduje Twoją dokumentację w stronę statyczną w build/: każdy dokument i wpis na blogu jako HTML, z wyszukiwarką i nawigacją działającymi w przeglądarce. Lobsite hostuje ten folder. Uruchom npm run build, potem npx lobsite, a dokumentacja będzie działać pod adresem *.lobsite.app z HTTPS. Każde wdrożenie dostaje też własny URL, co przydaje się do przeglądania zmian w dokumentacji, zanim trafią online.
Jak to działa
- Zbuduj dokumentację przez
npm run build. Docusaurus zapisze stronę wbuild/i domyślnie przerwie build przy zepsutych linkach. - Uruchom
npx lobsitew projekcie. Wdrażabuild/, a niestatic/. Pierwsze wdrożenie nie wymaga konta i trwa 6 godzin. - Zachowaj ją linkiem do przejęcia, na darmowym koncie. Potem
npm run build && npx lobsiteaktualizuje ten sam adres.
url, baseUrl i końcowe ukośniki
// docusaurus.config.js
export default {
url: "https://my-docs.lobsite.app",
baseUrl: "/",
};
urlto adres Twojej strony. Docusaurus używa go do linków kanonicznych i mapy strony.baseUrlw Lobsite to/. Strona projektu w GitHub Pages używa/repo-name/; jeśli to zostawisz, każdy link do zasobów przestanie działać.trailingSlashmożna pominąć. Dokumenty zbudowane jakodocs/intro/index.htmlotwierają się pod/docs/intro/;/docs/introprzekierowuje tam.
Przeglądanie zmian w dokumentacji
Dokumentację piszą różne osoby, a przegląda ją często ktoś inny. lobsite deploy --preview publikuje build pod własnym URL, nie ruszając działającej dokumentacji, więc recenzent czyta zmianę dokładnie tak, jak będzie wyglądać. lobsite promote publikuje ją, a lobsite rollback w jednym kroku wraca do poprzedniej wersji. Przenosisz strony? Dodaj przekierowania ze starych ścieżek do lobsite.toml, aby linki z wyników wyszukiwania i innych stron dalej działały; Generator przekierowań napisze reguły. Agenci AI do kodowania mogą wykonać to samo wdrożenie przez npx -y lobsite --yes, które nigdy nie zatrzymuje się, by o coś zapytać.
Podgląd przed publikacją. Wycofanie jednym kliknięciem, razem z przekierowaniami.
Pliki są przechowywane według hasha. Ponowne wdrożenie niezmienionej strony wgrywa 0 bajtów.
Każda strona dostaje adres *.lobsite.app z HTTPS od pierwszego wdrożenia.
Przekierowania, nagłówki i formularze są w lobsite.toml i wędrują z każdym wdrożeniem.
Żadnych pytań pod agentem i linia Tell the user: z adresem URL i linkiem do przejęcia.
Każdy limit jest opublikowany, a każdy błąd mówi, co zrobić dalej.
Porównanie hostingów dla Docusaurus
| Lobsite | GitHub Pages | Netlify | Vercel | |
|---|---|---|---|---|
| Buduje dokumentację za Ciebie | Nie: wdrażasz build/ |
W GitHub Actions albo docusaurus deploy |
Tak | Tak |
| URL podglądu dla każdego wdrożenia | Tak | Nie | Tak | Tak |
| Wycofanie w jednym kroku | Tak | Revert commita | Tak | Tak |
| Konto przed pierwszym wdrożeniem | Nie: 6 godzin online, potem zachowaj za darmo | Tak, i repozytorium | Tak | Tak |
| Własna domena | Tak, za darmo | Tak, za darmo | Tak | Tak |
GitHub Pages dobrze sprawdza się dla dokumentacji open source trzymanej obok kodu. Lobsite pasuje do dokumentacji, którą budujesz lokalnie lub w CI i chcesz podglądać, publikować i wycofywać bez workflow w Gicie wokół hostingu.
Najczęstsze pytania
Jakiego baseUrl powinien używać Docusaurus w Lobsite?
/. Strona jest serwowana od początku swojego adresu. Tylko strona projektu w GitHub Pages potrzebuje /repo-name/.
Czy wyszukiwarka Docusaurus działa na hostingu statycznym?
Tak. Algolia DocSearch działa w przeglądarce odwiedzającego, a lokalne wtyczki wyszukiwania budują swój indeks do build/. Żadne z nich nie potrzebuje serwera.
Czy mogę hostować wersjonowaną dokumentację Docusaurus?
Tak. Każda wersja jest budowana do build/ jako osobne strony, więc wszystkie wdrażają się razem. Wysyłane są tylko pliki zmienione od ostatniego wdrożenia.
Jak duża może być strona Docusaurus?
W darmowym planie do 100 plików i 50 MB na wdrożenie, co wystarcza większości stron z dokumentacją. Większa dokumentacja z wieloma wersjami lub obrazami wymaga płatnego planu, dostępnego wkrótce; wszystkie limity są w tabeli limitów.