Docusaurus збирає документацію в статичний сайт у build/: кожен документ і допис — як HTML, із пошуком і навігацією в браузері. Lobsite розміщує цю папку. Виконайте npm run build, потім npx lobsite — і документація доступна за адресою *.lobsite.app з HTTPS. Кожне розгортання також отримує власний URL, що зручно для перевірки змін перед публікацією.
Як це працює
- Зберіть документацію командою
npm run build. Docusaurus записує сайт уbuild/і за замовчуванням зупиняє збірку через неробочі посилання. - Виконайте
npx lobsiteу проєкті. Команда розгортаєbuild/, а неstatic/. Перше розгортання не потребує облікового запису й діє 6 годин. - Збережіть сайт за посиланням для збереження в безкоштовному обліковому записі. Надалі
npm run build && npx lobsiteоновлює ту саму адресу.
url, baseUrl і кінцеві слеші
// docusaurus.config.js
export default {
url: "https://my-docs.lobsite.app",
baseUrl: "/",
};
url— адреса сайту. Docusaurus використовує її для канонічних посилань і карти сайту.baseUrlна Lobsite —/. Сайт проєкту GitHub Pages використовує/repo-name/; якщо залишити це значення, усі посилання на ресурси зламаються.trailingSlashможна не вказувати. Документи, зібрані якdocs/intro/index.html, відкриваються за/docs/intro/;/docs/introперенаправляє туди.
Перевірка змін документації
Документацію пишуть багато людей, а перевіряє часто хтось інший. lobsite deploy --preview публікує збірку за власним URL, не змінюючи основну документацію, тож рецензент бачить зміни саме так, як вони виглядатимуть. lobsite promote публікує їх, а lobsite rollback повертає попередню версію за один крок. Переміщуєте сторінки? Додайте перенаправлення старих шляхів до lobsite.toml, щоб посилання з пошуку й інших сайтів працювали далі; генератор перенаправлень запише правила. AI-агенти для програмування можуть виконати те саме розгортання командою npx -y lobsite --yes, яка ніколи не зупиняється для запитань.
Перегляньте перед публікацією. Відкотіть одним натисканням разом із перенаправленнями.
Файли зберігаються за хешем. Повторне розгортання незміненого сайту завантажує 0 байтів.
Кожен сайт отримує адресу *.lobsite.app із HTTPS від першого розгортання.
Перенаправлення, заголовки та форми зберігаються в lobsite.toml і супроводжують кожне розгортання.
Без інтерактивних запитів для агента, з рядком Tell the user:, URL-адресою та посиланням для збереження.
Усі обмеження опубліковані, а кожна помилка підказує наступний крок.
Порівняння хостингів Docusaurus
| Lobsite | GitHub Pages | Netlify | Vercel | |
|---|---|---|---|---|
| Збирає документацію за вас | Ні: ви розгортаєте build/ |
У GitHub Actions або docusaurus deploy |
Так | Так |
| URL перегляду для кожного розгортання | Так | Ні | Так | Так |
| Відкат за один крок | Так | Скасувати коміт | Так | Так |
| Обліковий запис перед першим розгортанням | Ні: працює 6 годин, потім можна зберегти безкоштовно | Так, і репозиторій | Так | Так |
| Власний домен | Так, безкоштовно | Так, безкоштовно | Так | Так |
GitHub Pages добре підходить для відкритої документації поруч із кодом. Lobsite — для документації, яку ви збираєте локально чи в CI та хочете переглядати, публікувати й відкочувати без робочого процесу Git навколо хостингу.
Поширені запитання
Який baseUrl має використовувати Docusaurus на Lobsite?
/. Сайт віддається з кореня адреси. Лише сайту проєкту GitHub Pages потрібен /repo-name/.
Чи працює пошук Docusaurus на статичному хостингу?
Так. Algolia DocSearch працює в браузері відвідувача, а плагіни локального пошуку додають індекс у build/. Жодному з них не потрібен сервер.
Чи можна розмістити версійну документацію Docusaurus?
Так. Кожна версія збирається в build/ як окремі сторінки, тому всі вони розгортаються разом. Завантажуються лише файли, змінені після останнього розгортання.
Наскільки великим може бути сайт Docusaurus?
На безкоштовному плані — до 100 файлів і 50 МБ на розгортання, чого вистачає для більшості сайтів документації. Більшій документації з багатьма версіями чи зображеннями потрібен платний план, який незабаром з’явиться; усі обмеження наведено в таблиці лімітів.