Docusaurus bygger dokumentasjonen din til et statisk nettsted i build/: hvert dokument og hvert blogginnlegg som HTML, med søk og navigasjon som kjører i nettleseren. Lobsite hoster den mappen. Kjør npm run build, så npx lobsite, og dokumentasjonen er live på en *.lobsite.app-adresse med HTTPS. Hver deploy får også sin egen URL, nyttig for å gå gjennom endringer i dokumentasjonen før de går live.
Slik fungerer det
- Bygg dokumentasjonen med
npm run build. Docusaurus skriver nettstedet tilbuild/, og stopper bygget ved ødelagte lenker som standard. - Kjør
npx lobsitei prosjektet. Den deployerbuild/, ikkestatic/. Første deploy trenger ingen konto og varer i 6 timer. - Behold den med krav-lenken, i en gratis konto. Deretter oppdaterer
npm run build && npx lobsiteden samme adressen.
url, baseUrl og skråstrek til slutt
// docusaurus.config.js
export default {
url: "https://my-docs.lobsite.app",
baseUrl: "/",
};
urler adressen til nettstedet ditt. Docusaurus bruker den til kanoniske lenker og sitemap.baseUrler/på Lobsite. Et GitHub Pages-prosjektnettsted bruker/repo-name/; lar du det stå, blir alle ressurslenker ødelagt.trailingSlashkan utelates. Dokumenter bygget somdocs/intro/index.htmlåpnes på/docs/intro/;/docs/introvideresender dit.
Gå gjennom endringer i dokumentasjonen
Dokumentasjon skrives av mange og gjennomgås ofte av noen andre. lobsite deploy --preview publiserer bygget på sin egen URL uten å røre den live dokumentasjonen, så den som går gjennom leser endringen slik den vil se ut. lobsite promote gjør den live, og lobsite rollback går tilbake til forrige versjon i ett steg. Flytter du sider? Legg til videresendinger for de gamle stiene i lobsite.toml, så lenker fra søkeresultater og andre nettsteder fortsatt fungerer; Videresendingsgenerator skriver reglene. KI-kodeagenter kan kjøre den samme deployen med npx -y lobsite --yes, som aldri stopper for å spørre om noe.
Forhåndsvis før du går live. Rull tilbake med ett klikk, inkludert videresendinger.
Filer lagres etter hash. Å deploye et uendret nettsted på nytt laster opp 0 byte.
Hvert nettsted får en *.lobsite.app-adresse med HTTPS fra første deploy.
Videresendinger, headere og skjemaer ligger i lobsite.toml og følger med hver deploy.
Ingen spørsmål under en agent, og en Tell the user:-linje med URL-en og krav-lenken.
Hver grense er publisert, og hver feil forteller deg hva du skal gjøre videre.
Docusaurus-verter sammenlignet
| Lobsite | GitHub Pages | Netlify | Vercel | |
|---|---|---|---|---|
| Bygger dokumentasjonen for deg | Nei: du deployer build/ |
I GitHub Actions, eller docusaurus deploy |
Ja | Ja |
| Forhåndsvisnings-URL for hver deploy | Ja | Nei | Ja | Ja |
| Tilbakerulling i ett steg | Ja | Reverser en commit | Ja | Ja |
| Konto før første deploy | Nei: live i 6 timer, så behold det gratis | Ja, og et repository | Ja | Ja |
| Eget domene | Ja, gratis | Ja, gratis | Ja | Ja |
GitHub Pages fungerer godt for åpen kildekode-dokumentasjon som ligger ved siden av koden. Lobsite passer for dokumentasjon du bygger lokalt eller i CI og vil forhåndsvise, publisere og rulle tilbake uten en Git-arbeidsflyt rundt hostingen.
Ofte stilte spørsmål
Hvilken baseUrl bør Docusaurus bruke på Lobsite?
/. Nettstedet leveres fra roten av adressen sin. Bare et GitHub Pages-prosjektnettsted trenger /repo-name/.
Fungerer søket i Docusaurus på en statisk vert?
Ja. Algolia DocSearch kjører i besøkendes nettleser, og lokale søketillegg bygger indeksen sin inn i build/. Ingen av dem trenger en server.
Kan jeg hoste versjonert Docusaurus-dokumentasjon?
Ja. Hver versjon bygges inn i build/ som egne sider, så alle deployes sammen. Bare filer som er endret siden forrige deploy, lastes opp.
Hvor stort kan et Docusaurus-nettsted være?
På gratisplanen opptil 100 filer og 50 MB per deploy, som holder for de fleste dokumentasjonsnettsteder. Større dokumentasjon med mange versjoner eller bilder trenger betalingsplanen som kommer snart; alle grensene står i tabellen over grenser.