GitBook adalah platform yang memungkinkan Anda dan tim Anda untuk membuat dan berkolaborasi di situs dokumentasi. GitBook melakukan ini dengan menggunakan konsep kontrol versi, seperti percabangan dan penggabungan.

Karena banyak anggota tim dapat bekerja di satu situs dokumentasi, GitBook memungkinkan Anda membuat dan mengelola draf terpisah. Anda juga dapat melihat perbedaan antara draf Anda saat ini dan salinan dokumentasi master.

Beberapa jenis blok tersedia untuk Anda tambahkan ke halaman wiki Anda. Ini termasuk judul, paragraf, gambar, petunjuk, tabel, blok kode, lampiran file, dan banyak lagi.

Cara Menambahkan Blok Konten di GitBook

Anda dapat melihat daftar blok konten yang tersedia untuk ditambahkan ke halaman. Anda dapat melakukan ini dengan mengklik di mana saja pada halaman dan mengklik plus simbol yang muncul. Anda juga dapat langsung mencari blok konten tertentu.

Anda dapat menambahkan konten menggunakan penurunan harga. Jika Anda belum pernah menggunakan penurunan harga sebelumnya, Anda dapat mempelajari lebih lanjut tentang

instagram viewer
bagaimana memulai dengan penurunan harga. Anda juga dapat membaca lebih lanjut tentang mengapa penurunan harga sangat populer.

Cara Menambahkan Paragraf, Daftar, Kutipan, atau Blok Kode

Untuk menambahkan daftar, paragraf, kutipan, blok kode, atau blok konten sederhana lainnya, buka dropdown dan pilih dari jenis yang tersedia.

  1. Pada halaman di situs dokumentasi Anda, klik pada plus tombol di lokasi di mana Anda ingin menambahkan konten Anda.
  2. Dari dropdown, Anda dapat menggulir daftar untuk melihat opsi konten yang berbeda.
  3. Dari sini, pilih tipe konten sederhana, seperti paragraf, blok kode, judul, atau kutipan. GitBook akan secara otomatis mengubah konten agar sesuai dengan format yang Anda pilih.

Cara Menambahkan Gambar atau Lampiran File

Untuk menambahkan gambar, gunakan dropdown untuk memilih Gambar-gambar opsi blok konten. Untuk menambahkan file, pilih Sisipkan File pilihan sebagai gantinya. Anda kemudian dapat menggunakan panel sebelah kanan untuk mengelola gambar dan file yang Anda unggah.

  1. Buka halaman di situs dokumentasi Anda. Klik pada plus tombol untuk membuka dropdown untuk blok konten yang tersedia.
  2. Pilih Sisipkan Gambar.
  3. Di panel sebelah kanan yang muncul, ada tiga tab. Itu File tab memungkinkan Anda untuk mengunggah file gambar Anda sendiri. Itu URL tab memungkinkan Anda menautkan ke gambar secara online. Anda juga dapat membuka Hapus percikan tab. Di sinilah Anda dapat memilih foto yang ada yang tidak memerlukan atribusi.
  4. Setelah Anda menambahkan gambar, klik pada tiga titik tombol yang terletak di sudut kiri atas gambar. Ini akan membuka dropdown di mana Anda dapat menyelaraskan gambar, atau menghapusnya. Anda juga dapat memberikan keterangan pada gambar.
  5. Untuk menyisipkan file, letakkan kursor Anda di mana saja pada halaman di situs dokumentasi Anda. Klik pada plus untuk membuka tarik-turun jenis blok konten. Kali ini, klik pada masukkan file pilihan.
  6. Panel sebelah kanan yang serupa akan muncul, memungkinkan Anda mengunggah lampiran file apa pun alih-alih gambar. Klik Mencari berkas untuk memilih file yang disimpan secara lokal di komputer Anda.
  7. File akan muncul di daftar. Klik pada file tersebut, dan GitBook akan membuat blok konten dengan lampiran file pada halaman yang telah Anda buka. Mengklik blok konten ini akan mengunduh lampiran file.

Bagaimana Menambahkan Petunjuk

Anda juga dapat menambahkan petunjuk ke halaman Anda. Anda dapat mengubah ikon petunjuk untuk menggunakan merah untuk bahaya, oranye untuk peringatan, biru untuk informasi, atau hijau untuk sukses.

  1. Untuk menambahkan petunjuk, klik pada plus tombol untuk membuka dropdown untuk blok konten yang tersedia.
  2. Pilih Petunjuk.
  3. Ini akan menambahkan petunjuk ke halaman Anda. Secara default, tipe petunjuk adalah "informasi", dan berisi ikon biru.
  4. Anda dapat mengubah jenis petunjuk dengan mengklik ikon. Ini akan mengulang empat jenis petunjuk yang berbeda.

Bagaimana Menambahkan Tabel

Anda dapat menambahkan tabel dengan memilih meja pilihan dari daftar dropdown. Setelah Anda memiliki tabel di halaman, Anda dapat menambahkan baris atau kolom baru. Anda juga dapat mengubah nama dan tipe data kolom, dan mengubah data di dalam tabel.

  1. Klik pada plus tombol untuk membuka dropdown untuk blok konten yang tersedia.
  2. Pilih Meja.
  3. Klik pada header kolom dalam tabel. Ini akan membuka menu baru yang lebih kecil, di mana Anda dapat mengubah nama kolom yang dipilih. Menu ini juga memungkinkan Anda untuk menghapus atau menyembunyikan kolom yang dipilih. Untuk tipe data kolom tertentu, Anda juga bisa meratakan konten di dalam kolom.
  4. Secara default, tipe data yang dipilih untuk kolom adalah "Teks". Klik tombol dengan T simbol untuk mengubah tipe data. Anda dapat mengubahnya menjadi angka, kotak centang, dropdown, lampiran file, peringkat, atau lainnya.
  5. Klik pada ikon enam titik dekat sudut kiri atas tabel. Di sini Anda dapat menyisipkan kolom dan baris baru atau menghapus seluruh tabel. Anda juga dapat menyembunyikan atau memperlihatkan kolom tertentu, atau mengubah properti lain untuk tabel.

Cara Menambahkan Blok Tautan Halaman

Blok tautan halaman adalah tautan yang mengambil seluruh baris pada halaman. Saat Anda menambahkan tautan, Anda harus menautkan ke halaman yang akan terbuka ketika seseorang mengkliknya.

  1. Klik pada plus tombol untuk membuka dropdown untuk blok konten yang tersedia.
  2. Klik Tautan Halaman.
  3. Dari dropdown baru, pilih halaman yang Anda tautkan.
  4. Tautan halaman Anda akan muncul di dalam blok pada halaman.

Menggunakan GitBook untuk Dokumentasi

GitBook adalah alat dokumentasi yang menggunakan konsep kontrol versi seperti percabangan dan penggabungan. Ini memungkinkan lebih dari satu anggota tim untuk secara bersamaan mengerjakan dokumentasi. Ini juga membantu untuk mengelola setiap konflik yang terjadi.

Anda dapat menambahkan semua jenis blok konten ke halaman. Anda dapat menggunakan judul, paragraf, blok kode, atau poin-poin untuk memformat ulang konten Anda. Anda dapat mengubah jenis petunjuk, pesan, dan jenis ikon petunjuk, serta menyesuaikan kolom tabel.

Tab File memungkinkan Anda untuk mengelola gambar dan lampiran file yang Anda unggah ke situs. Tautan Halaman memungkinkan Anda membuat tautan besar yang dapat dilihat dengan mudah oleh pengguna.

Jika Anda membuat dokumentasi yang terkait dengan bahasa Go, Anda dapat menggunakan Godoc. Godoc memungkinkan Anda untuk mendokumentasikan kode Go Anda secara otomatis.