Docusaurus bouwt je documentatie tot een statische site in build/: elk document en elk blogbericht als HTML, met zoeken en navigatie die in de browser draaien. Lobsite host die map. Voer npm run build uit, dan npx lobsite, en je documentatie staat live op een *.lobsite.app-adres met HTTPS. Elke deploy krijgt ook een eigen URL, handig om wijzigingen in de documentatie te controleren voor ze live gaan.
Zo werkt het
- Bouw de documentatie met
npm run build. Docusaurus schrijft de site naarbuild/en laat de build standaard mislukken bij kapotte links. - Voer
npx lobsiteuit in het project. Het deploytbuild/, nietstatic/. De eerste deploy heeft geen account nodig en duurt 6 uur. - Houd haar met de claimlink, in een gratis account. Daarna werkt
npm run build && npx lobsitehetzelfde adres bij.
url, baseUrl en slashes aan het eind
// docusaurus.config.js
export default {
url: "https://my-docs.lobsite.app",
baseUrl: "/",
};
urlis het adres van je site. Docusaurus gebruikt het voor canonieke links en de sitemap.baseUrlis/op Lobsite. Een GitHub Pages-projectsite gebruikt/repo-name/; laat je dat staan, dan is elke assetlink kapot.trailingSlashkun je weglaten. Documenten gebouwd alsdocs/intro/index.htmlopenen op/docs/intro/;/docs/introverwijst daarheen door.
Wijzigingen in de documentatie controleren
Documentatie wordt door veel mensen geschreven en vaak door iemand anders nagekeken. lobsite deploy --preview publiceert de build op een eigen URL zonder de live documentatie aan te raken, zodat wie nakijkt de wijziging leest zoals hij eruit gaat zien. lobsite promote zet hem live, en lobsite rollback gaat in één stap terug naar de vorige versie. Verplaats je pagina's? Voeg doorverwijzingen voor de oude paden toe aan lobsite.toml, zodat links uit zoekresultaten en van andere sites blijven werken; de Doorverwijzingsgenerator schrijft de regels. AI-codeeragents kunnen dezelfde deploy uitvoeren met npx -y lobsite --yes, dat nooit stopt om een vraag te stellen.
Bekijk een voorbeeld voordat het live gaat. Zet in één klik terug, inclusief doorverwijzingen.
Bestanden worden op hun hash opgeslagen. Een ongewijzigde site opnieuw deployen uploadt 0 bytes.
Elke site krijgt vanaf de eerste deploy een *.lobsite.app-adres met HTTPS.
Doorverwijzingen, headers en formulieren staan in lobsite.toml en reizen mee met elke deploy.
Geen vragen onder een agent, en een Tell the user:-regel met de URL en de claimlink.
Elke limiet is gepubliceerd, en elke fout vertelt je wat je moet doen.
Docusaurus-hosts vergeleken
| Lobsite | GitHub Pages | Netlify | Vercel | |
|---|---|---|---|---|
| Bouwt de documentatie voor je | Nee: je deployt build/ |
In GitHub Actions, of docusaurus deploy |
Ja | Ja |
| Voorbeeld-URL voor elke deploy | Ja | Nee | Ja | Ja |
| Terugdraaien in één stap | Ja | Een commit terugdraaien | Ja | Ja |
| Account vóór de eerste deploy | Nee: 6 uur live, daarna gratis houden | Ja, en een repository | Ja | Ja |
| Eigen domein | Ja, gratis | Ja, gratis | Ja | Ja |
GitHub Pages werkt goed voor opensourcedocumentatie die naast de code staat. Lobsite past bij documentatie die je lokaal of in CI bouwt en wilt bekijken, live zetten en terugdraaien zonder Git-workflow rond de hosting.
Veelgestelde vragen
Welke baseUrl moet Docusaurus op Lobsite gebruiken?
/. De site wordt vanaf de basis van zijn adres geserveerd. Alleen een GitHub Pages-projectsite heeft /repo-name/ nodig.
Werkt zoeken in Docusaurus op een statische host?
Ja. Algolia DocSearch draait in de browser van de bezoeker, en lokale zoekplug-ins bouwen hun index in build/. Geen van beide heeft een server nodig.
Kan ik geversioneerde Docusaurus-documentatie hosten?
Ja. Elke versie wordt als eigen pagina's in build/ gebouwd, dus ze worden allemaal samen gedeployd. Alleen bestanden die sinds de vorige deploy zijn veranderd, worden geüpload.
Hoe groot mag een Docusaurus-site zijn?
Op het gratis abonnement tot 100 bestanden en 50 MB per deploy, genoeg voor de meeste documentatiesites. Grotere documentatie met veel versies of afbeeldingen heeft het betaalde abonnement nodig, binnenkort beschikbaar; alle limieten staan in de tabel met limieten.