gitbook

Gitbook

Dokumen - Komunitas - Pengembang Dokumen - Changelog - Laporan Bug

Selamat datang di GitBook, platform untuk mengelola pengetahuan teknis untuk tim.

Repositori ini berisi kode sumber terbuka yang digunakan untuk membuat konten yang dipublikasikan Gitbook.

Daftar isi

• Memulai

• Berkontribusi

• Jenis kontribusi

• Lisensi

• Ucapan Terima Kasih

• Buku Giten Legacy

Memulai

Untuk menjalankan versi lokal dari proyek ini, silakan ikuti langkah -langkah sederhana ini.

Prasyarat

• Node.js (versi:> = 18.x)

• Sanggul

Mendirikan

1. Kloning repo ke dalam repositori github publik . Jika Anda berencana untuk mendistribusikan kode, menjaga kode sumber publik untuk mematuhi GNU GPLV3. Untuk mengkloning dalam repositori pribadi, memperoleh lisensi komersial.

git clone https://github.com/gitbookIO/gitbook.git

2. Pastikan Anda menggunakan node versi proyek. Menjalankan nvm use akan mengubah versi lokal Anda ke yang benar.

3. Instal dependensi proyek melalui BUN.

bun install

4. Mulai server pengembangan lokal Anda.

bun dev

5. Buka ruang gitbook yang diterbitkan di browser web Anda, diawali dengan http://localhost:3000/ .

Contoh:

• http: // localhost: 3000/docs.gitbook.com

• http: // localhost: 3000/open-source.gitbook.io/midjourney

Situs gitbook apa pun yang diterbitkan dapat diakses melalui instance pengembangan lokal Anda, dan setiap pembaruan yang Anda lakukan ke basis kode akan tercermin di browser Anda.

Perintah pengembangan lainnya

• bun format : Format kode

• bun lint : lint kode

CI dan pengujian

Semua permintaan tarik akan diuji terhadap pengujian visual dan kinerja untuk mencegah regresi.

Berkontribusi

Mesin rendering GitBook sepenuhnya open source dan dibangun di atas Next.js. Buka panduan berkontribusi kami untuk mempelajari lebih lanjut tentang alur kerja tentang menambahkan permintaan tarik pertama Anda.

Jenis kontribusi

Kami mendorong Anda untuk berkontribusi ke GitBook untuk membantu kami membangun alat terbaik untuk mendokumentasikan pengetahuan teknis. Jika Anda mencari beberapa cara cepat untuk berkontribusi, lanjutkan membaca untuk mempelajari lebih lanjut tentang kontribusi populer.

Terjemahan

GitBook UI diberikan menggunakan satu set file terjemahan yang ditemukan dalam packages/gitbook/src/intl/translations . Kami menyambut semua terjemahan tambahan untuk UI.

Serangga

Temui bug atau temukan masalah yang ingin Anda perbaiki? Membantu kami memperbaiki masalah yang terkait dengan GitBook sangat meningkatkan pengalaman untuk semua orang. Pergilah ke bagian masalah repositori ini untuk mempelajari lebih lanjut tentang jenis bug yang sudah dapat Anda bantu.

Penyebaran

Peringatan

Meskipun dimungkinkan untuk menjadi tuan rumah proyek ini, kami tidak merekomendasikan ini kecuali Anda yakin opsi ini sesuai dengan kebutuhan Anda.

Ingin menambahkan fitur tertentu di GitBook? Pergilah ke panduan berkontribusi kami untuk memulai.

PEMBERI MUSTAKA Proyek ini menempatkan tanggung jawab mempertahankan dan menggabungkan pembaruan di masa depan pada Anda . Kami tidak dapat menjamin dukungan, pemeliharaan, atau pembaruan untuk contoh-contoh bercabang dan hosting sendiri dari proyek ini.

Kami ingin membuatnya semudah mungkin bagi komunitas kami untuk berkolaborasi dan mendorong masa depan GitBook, itulah sebabnya kami mendorong Anda untuk berkontribusi pada produk kami secara langsung alih -alih membuat versi Anda sendiri.

Proyek ini memungkinkan Anda untuk menjadi tuan rumah mandiri bagian rendering dari konten Gitbook Anda yang diterbitkan. Penculik diri memiliki pro dan kontra.

Di sisi pro, Anda dapat menyesuaikan tampilan dan nuansa konten Anda, dan lebih baik menyematkan dokumentasi Anda di aplikasi Anda.

Di sisi Con, Anda menjadi bertanggung jawab atas keandalan situs yang Anda diterbitkan, dan menjaga agar renderer tetap mutakhir dengan perubahan yang dilakukan pada platform GitBook.

Lisensi

Didistribusikan di bawah lisensi GNU GPLV3.

Jika Anda berencana untuk mendistribusikan kode, Anda harus membuat kode sumber publik untuk mematuhi GNU GPLV3. Untuk mengkloning dalam repositori pribadi, memperoleh lisensi komersial.

Lihat LICENSE untuk informasi lebih lanjut.

Lencana

 [! [GitBook] (https://img.shields.io/static/v1?message=Documented%20on%20gitbook&logo=gitbook&logocolor=ffffff&label=%20&labelcolor=5c5c5c&color=3f8999) (hm) (hlabelor=5c5c5c&color=3f89) (hm) (hm) (hlabelor=)

 <a href = "https://gitbook.com"> <imgsrc = "https://img.shields.io/static/v1?message=documented%20on%20gitbook&logo=gitbook&logocolor=ffffFFF&label=%20or=colc&logocolor=ffffF&label=%20or=colc&logocolor=ffFFFFFFF&Label=%20 "
    /> </a>

Ucapan Terima Kasih

GitBook tidak akan mungkin tanpa proyek ini:

• Next.js

• Sanggul

• Tailwind CSS

• Gerakan Pembingkaian

Kontributor

Legacy Gitbook (sudah usang)

Versi gitbook kami sebelumnya dan alat CLI sekarang sudah usang. Anda masih dapat melihat repositori lama dan itu berkomitmen pada cabang ini.