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 перенаправления со старых путей, чтобы ссылки из поисковой выдачи и с других сайтов продолжали работать; Генератор перенаправлений напишет правила. ИИ-агенты для программирования могут выполнить тот же деплой через 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 предпросмотра для каждого деплоя | Да | Нет | Да | Да |
| Откат за один шаг | Да | Revert коммита | Да | Да |
| Аккаунт до первого деплоя | Нет: 6 часов онлайн, затем сохраните бесплатно | Да, и репозиторий | Да | Да |
| Свой домен | Да, бесплатно | Да, бесплатно | Да | Да |
GitHub Pages хорошо подходит для open-source-документации, которая лежит рядом с кодом. Lobsite подойдёт для документации, которую вы собираете локально или в CI и хотите просматривать, публиковать и откатывать без Git-процесса вокруг хостинга.
Частые вопросы
Какой baseUrl указать для Docusaurus в Lobsite?
/. Сайт отдаётся от корня своего адреса. /repo-name/ нужен только сайту проекта в GitHub Pages.
Работает ли поиск Docusaurus на статическом хостинге?
Да. Algolia DocSearch работает в браузере посетителя, а плагины локального поиска собирают свой индекс в build/. Ни тому, ни другому не нужен сервер.
Можно ли разместить документацию Docusaurus с версиями?
Да. Каждая версия собирается в build/ отдельными страницами, поэтому все они деплоятся вместе. Загружаются только файлы, изменившиеся с прошлого деплоя.
Насколько большим может быть сайт на Docusaurus?
На бесплатном тарифе — до 100 файлов и 50 МБ на деплой, этого хватает большинству сайтов документации. Для документации побольше, с множеством версий или изображений, нужен платный тариф, который скоро появится; все ограничения есть в таблице ограничений.