Docusaurus membuat dokumentasi Anda menjadi situs statis di build/: setiap dokumen dan posting blog sebagai HTML, dengan pencarian dan navigasi yang berjalan di browser. Lobsite meng-host folder itu. Jalankan npm run build, lalu npx lobsite, dan dokumentasi Anda aktif di alamat *.lobsite.app dengan HTTPS. Setiap deploy juga mendapat URL sendiri, yang berguna untuk meninjau perubahan dokumentasi sebelum tayang.
Cara kerjanya
- Build dokumentasi dengan
npm run build. Docusaurus menulis situs kebuild/, dan secara bawaan menggagalkan build jika ada tautan rusak. - Jalankan
npx lobsitedi proyek. Perintah ini melakukan deploybuild/, bukanstatic/. Deploy pertama tidak memerlukan akun dan bertahan 6 jam. - Simpan dengan tautan klaim, di akun gratis. Setelah itu,
npm run build && npx lobsitememperbarui alamat yang sama.
url, baseUrl, dan garis miring di akhir
// docusaurus.config.js
export default {
url: "https://my-docs.lobsite.app",
baseUrl: "/",
};
urladalah alamat situs Anda. Docusaurus memakainya untuk tautan kanonis dan sitemap.baseUrladalah/di Lobsite. Situs proyek GitHub Pages memakai/repo-name/; membiarkannya merusak setiap tautan aset.trailingSlashdapat dihilangkan. Dokumen yang dibuat sebagaidocs/intro/index.htmlterbuka di/docs/intro/;/docs/introdialihkan ke sana.
Meninjau perubahan dokumentasi
Dokumentasi ditulis banyak orang dan sering ditinjau orang lain. lobsite deploy --preview memublikasikan build di URL sendiri tanpa menyentuh dokumentasi aktif, sehingga peninjau membaca perubahan sesuai tampilan akhirnya. lobsite promote menayangkannya, dan lobsite rollback kembali ke versi sebelumnya dalam satu langkah. Memindahkan halaman? Tambahkan pengalihan untuk path lama ke lobsite.toml agar tautan dari hasil pencarian dan situs lain tetap berfungsi; Generator Pengalihan menulis aturannya. Agen coding AI dapat menjalankan deploy yang sama dengan npx -y lobsite --yes, yang tidak pernah berhenti untuk bertanya.
Pratinjau sebelum tayang. Rollback dengan satu klik, termasuk pengalihan.
File disimpan berdasarkan hash-nya. Deploy ulang situs yang tidak berubah mengunggah 0 byte.
Setiap situs mendapat alamat *.lobsite.app dengan HTTPS sejak deploy pertama.
Pengalihan, header, dan formulir ada di lobsite.toml dan ikut bersama setiap deploy.
Tanpa pertanyaan saat dijalankan agen, dan baris Tell the user: berisi URL dan tautan klaim.
Setiap batas dipublikasikan, dan setiap error memberi tahu langkah selanjutnya.
Perbandingan host Docusaurus
| Lobsite | GitHub Pages | Netlify | Vercel | |
|---|---|---|---|---|
| Membuat dokumentasi untuk Anda | Tidak: Anda deploy build/ |
Di GitHub Actions, atau docusaurus deploy |
Ya | Ya |
| URL pratinjau untuk setiap deploy | Ya | Tidak | Ya | Ya |
| Rollback dalam satu langkah | Ya | Membatalkan commit | Ya | Ya |
| Akun sebelum deploy pertama | Tidak: aktif 6 jam, lalu simpan gratis | Ya, dan repositori | Ya | Ya |
| Domain kustom | Ya, gratis | Ya, gratis | Ya | Ya |
GitHub Pages cocok untuk dokumentasi open source yang berdampingan dengan kode. Lobsite cocok untuk dokumentasi yang Anda buat secara lokal atau di CI dan ingin dipratinjau, dipromosikan, dan di-rollback tanpa alur kerja Git di sekitar hosting.
Pertanyaan umum
baseUrl mana yang harus dipakai Docusaurus di Lobsite?
/. Situs disajikan dari tingkat atas alamatnya. Hanya situs proyek GitHub Pages yang memerlukan /repo-name/.
Apakah pencarian Docusaurus berfungsi di host statis?
Ya. Algolia DocSearch berjalan di browser pengunjung, dan plugin pencarian lokal membuat indeksnya ke build/. Keduanya tidak memerlukan server.
Bisakah saya meng-host dokumentasi Docusaurus berversi?
Ya. Setiap versi dibuat ke build/ sebagai halamannya sendiri, sehingga semuanya di-deploy bersama. Hanya file yang berubah sejak deploy terakhir yang diunggah.
Seberapa besar situs Docusaurus bisa dibuat?
Pada paket gratis, hingga 100 file dan 50 MB per deploy, yang cukup untuk sebagian besar situs dokumentasi. Dokumentasi lebih besar dengan banyak versi atau gambar memerlukan paket berbayar, segera hadir; setiap batas ada di tabel batas.