Docusaurus transforme votre documentation en site statique dans build/ : chaque doc et chaque article de blog en HTML, avec une recherche et une navigation qui tournent dans le navigateur. Lobsite héberge ce dossier. Lancez npm run build, puis npx lobsite, et votre documentation est en ligne à une adresse *.lobsite.app en HTTPS. Chaque déploiement a aussi sa propre URL, pratique pour relire les changements de documentation avant leur mise en ligne.
Comment ça marche
- Buildez la documentation avec
npm run build. Docusaurus écrit le site dansbuild/et, par défaut, fait échouer le build en cas de liens cassés. - Lancez
npx lobsitedans le projet. Il déploiebuild/, passtatic/. Le premier déploiement ne demande pas de compte et dure 6 heures. - Gardez-la grâce au lien de récupération, dans un compte gratuit. Ensuite,
npm run build && npx lobsitemet à jour la même adresse.
url, baseUrl et barres obliques finales
// docusaurus.config.js
export default {
url: "https://my-docs.lobsite.app",
baseUrl: "/",
};
urlest l’adresse de votre site. Docusaurus l’utilise pour les liens canoniques et le sitemap.baseUrlvaut/sur Lobsite. Un site de projet GitHub Pages utilise/repo-name/; le laisser casse tous les liens vers les ressources.trailingSlashpeut être omis. Les docs buildées endocs/intro/index.htmls’ouvrent à/docs/intro/;/docs/introy redirige.
Relire les changements de documentation
La documentation est écrite par beaucoup de monde et souvent relue par quelqu’un d’autre. lobsite deploy --preview publie le build à sa propre URL sans toucher à la documentation en ligne : la personne qui relit voit le changement tel qu’il apparaîtra. lobsite promote le met en ligne, et lobsite rollback revient à la version précédente en une étape. Vous déplacez des pages ? Ajoutez des redirections pour les anciens chemins dans lobsite.toml, pour que les liens depuis les résultats de recherche et les autres sites continuent de fonctionner ; le Générateur de redirections écrit les règles. Les agents de code IA peuvent lancer le même déploiement avec npx -y lobsite --yes, qui ne s’arrête jamais pour poser une question.
Prévisualisez avant la mise en ligne. Revenez en arrière en un clic, redirections comprises.
Les fichiers sont stockés selon leur hash. Redéployer un site inchangé envoie 0 octet.
Chaque site reçoit une adresse *.lobsite.app en HTTPS dès le premier déploiement.
Redirections, en-têtes et formulaires vivent dans lobsite.toml et accompagnent chaque déploiement.
Aucune question posée sous un agent, et une ligne Tell the user: avec l’URL et le lien de récupération.
Chaque limite est publiée, et chaque erreur vous dit quoi faire ensuite.
Hébergeurs Docusaurus comparés
| Lobsite | GitHub Pages | Netlify | Vercel | |
|---|---|---|---|---|
| Builde la documentation pour vous | Non : vous déployez build/ |
Dans GitHub Actions, ou docusaurus deploy |
Oui | Oui |
| URL d’aperçu pour chaque déploiement | Oui | Non | Oui | Oui |
| Retour arrière en une étape | Oui | Annuler un commit | Oui | Oui |
| Compte avant le premier déploiement | Non : en ligne 6 heures, puis à garder gratuitement | Oui, et un dépôt | Oui | Oui |
| Domaine personnalisé | Oui, gratuit | Oui, gratuit | Oui | Oui |
GitHub Pages convient bien à une documentation open source qui vit à côté du code. Lobsite convient à une documentation que vous buildez en local ou en CI et que vous voulez prévisualiser, mettre en ligne et restaurer sans workflow Git autour de l’hébergement.
Questions fréquentes
Quelle baseUrl Docusaurus doit-il utiliser sur Lobsite ?
/. Le site est servi depuis la racine de son adresse. Seul un site de projet GitHub Pages a besoin de /repo-name/.
La recherche de Docusaurus fonctionne-t-elle sur un hébergeur statique ?
Oui. Algolia DocSearch tourne dans le navigateur du visiteur, et les plugins de recherche locale construisent leur index dans build/. Aucun des deux n’a besoin de serveur.
Puis-je héberger une documentation Docusaurus versionnée ?
Oui. Chaque version est buildée dans build/ sous forme de pages distinctes, donc toutes se déploient ensemble. Seuls les fichiers modifiés depuis le dernier déploiement sont envoyés.
Quelle taille peut atteindre un site Docusaurus ?
Avec l’offre gratuite, jusqu’à 100 fichiers et 50 Mo par déploiement, ce qui suffit à la plupart des sites de documentation. Une documentation plus volumineuse, avec beaucoup de versions ou d’images, demande l’offre payante, bientôt disponible ; toutes les limites figurent dans le tableau des limites.