Cara Membuat Wiki Dalaman Mudah Menggunakan Gitbook

Cara Membuat Wiki Dalaman Mudah Menggunakan Gitbook

GitBook ialah platform yang membolehkan anda membina tapak dokumentasi atau wiki syarikat. Anda boleh menggunakannya untuk mendokumenkan semua jenis perkara, daripada kod kepada API dan cara menggunakan produk perisian.





GitBook menggunakan proses yang serupa dengan repositori GitHub. Salinan utama dokumentasi bertindak sebagai salinan 'master'. Anda kemudian boleh membuat 'draf', yang serupa dengan 'cawangan'.



Proses ini membolehkan ramai pengguna bekerja pada tapak dokumentasi tunggal sambil mengendalikan atau mencegah konflik. Ia juga membenarkan perubahan daripada cawangan yang berbeza melalui proses semakan sebelum anda menggabungkannya.





Bagaimana untuk Mula Menggunakan GitBook

Anda boleh memilih daripada beberapa Harga GitBook rancangan. Harga bergantung pada sama ada anda menggunakan GitBook untuk projek sumber terbuka, penggunaan peribadi atau kerjasama pasukan persendirian. GitBook adalah percuma untuk digunakan jika anda menggunakannya untuk projek sumber terbuka.

GitBook menyokong Markdown, bahasa markup yang popular dengan banyak faedah untuk menulis atau mendokumentasikan di web.



cara merobek blu-ray

GitBook juga berintegrasi dengan GitHub, platform untuk mengehos, menyimpan dan menyunting kod . Anda boleh memautkan akaun GitBook anda terus ke akaun GitHub anda dengan melog masuk menggunakan bukti kelayakan GitHub anda.

  1. Daftar ke GitBook. Jika anda mempunyai akaun GitHub anda sendiri, anda boleh klik pada Daftar Dengan GitHub .
  2. Setelah anda melog masuk, GitBook akan mengubah hala anda ke wiki dalaman baharu. Ia juga akan pra-populasi wiki anda dengan beberapa kandungan sampel.

Gambaran Keseluruhan Antara Muka GitBook

GitBook mempunyai beberapa fungsi yang membolehkan anda membina dan membuat perubahan pada tapak dokumentasi anda.



  1. Panel atas membolehkan anda membuat draf baharu, melihat sejarah perubahan atau melihat sebarang perbincangan atau lampiran lain.
  2. Bar sisi paling kiri membolehkan anda mencipta berbilang ruang. Anda boleh menggunakan ruang yang berasingan untuk projek yang berbeza supaya anda boleh memisahkan dan mengatur kawasan dokumentasi anda. Anda boleh mengembangkan atau menutup bar sisi.
  3. Panel kiri bertindak sebagai menu untuk tapak dokumentasi. Anda boleh melihat halaman dalam tapak dokumentasi anda dan menggunakannya untuk membuat kumpulan dan halaman bersarang. Anda juga boleh menavigasi merentasi tapak menggunakan pautan yang disediakan.
  4. Panel bawah termasuk butang yang penting untuk proses kawalan versi. Anda boleh menambah nama untuk draf anda, menggabungkan perubahan atau menyerahkan perubahan untuk semakan.

Cara Membuat Draf Baharu

Anda boleh membuat draf baharu dengan membuat Permintaan Perubahan baharu dan membuat perubahan di dalamnya.

  1. Di panel atas, klik pada Permintaan Tukar .
  2. Pada panel baharu yang muncul di sebelah kanan, klik pada Draf tab. Ini akan menunjukkan kepada anda semua draf aktif anda.
  3. Dari sini, anda boleh mengklik pada draf sedia ada untuk membukanya. Untuk membuat draf baharu, klik pada Permintaan perubahan baharu , dan tunggu sehingga halaman selesai dimuatkan.
  4. Di panel bawah, klik pada Masukkan Subjek . Ini akan membuka tetingkap di mana anda boleh memberi draf baharu nama. Sebagai contoh, Halaman Baharu - Cara Menyediakan Pangkalan Kod .

Cara Membuat Halaman dan Kumpulan

Sebaik sahaja anda mempunyai draf, anda boleh mula membuat perubahan pada dokumentasi. GitBook menyimpan perubahan anda di dalam draf, jadi ia tidak menjejaskan salinan induk. Anda boleh menggunakan bar sisi kiri untuk menambah halaman dan kumpulan halaman.



  1. Buat halaman baharu dengan mengklik pada Halaman Baharu pautan di bahagian bawah bar sisi, dan memilih Halaman dokumen baharu daripada dropdown. Sebagai alternatif, anda boleh menuding di bawah halaman sedia ada dan klik pada biru tambah lagi butang.
  2. Untuk membuat Kumpulan Halaman baharu, klik pada Halaman Baharu , dan pilih Kumpulan baru pilihan daripada menu lungsur.
  3. Anda boleh menamakan semula halaman dengan mengklik pada tiga titik di sebelah halaman atau kumpulan, dan memilih Namakan semula .
  4. Mula menambah kandungan untuk mengisi halaman baharu anda. Anda boleh menambah kandungan mudah seperti teks atau tajuk. GitBook juga membolehkan anda menambah blok kandungan lain seperti imej, lampiran fail, jadual, tab atau coretan kod. Terdapat juga pilihan untuk menambah penyepaduan lain seperti benaman YouTube atau kandungan Google Docs.
  5. Klik pada Pandangan berbeza butang di panel bawah untuk melihat perbezaan antara draf anda dan salinan dokumentasi induk asal.
  6. Setelah anda selesai menulis kandungan anda, anda boleh klik pada Bercantum , Serahkan dan gabungkan , atau Hantar untuk semakan .

Anda boleh mengakses pautan kongsi dari panel atas GitBook. Anda perlu keluar dari draf dan melihat salinan dokumentasi induk untuk dapat melihat pautan.

  1. Secara lalai, keterlihatan tapak dokumentasi anda adalah 'tidak tersenarai'. Ini bermakna anda boleh mengakses tapak dokumentasi menggunakan pautan peribadi, dan bukan melalui enjin carian. Di panel atas, klik pada Tidak tersenarai butang.
  2. Pilih tetapan keterlihatan yang anda inginkan daripada menu lungsur. Ambil perhatian bahawa GitBook mungkin mengunci tetapan keterlihatan tertentu dan anda mungkin perlu meningkatkan untuk mengaksesnya.
  3. Di bawah senarai tetapan keterlihatan, terdapat pautan yang boleh anda kongsi dengan pengguna lain yang akan menggunakan tapak dokumentasi anda. Salin pautan ini untuk berkongsi dengan orang lain.
  4. Di bawah pautan, klik pada Tetapan pautan dan domain . Di sinilah anda boleh memautkan nama domain tersuai, atau mengubah suai sebahagian daripada URL. Jika anda menggunakan domain tersuai, anda boleh melihat dokumentasi Gitbook tentang cara mengkonfigurasi DNS anda dengan betul.

Mencipta Dokumentasi Menggunakan GitBook

GitBook membolehkan anda membuat dan bekerja secara kolaboratif pada tapak dokumentasi atau wiki syarikat. GitBook meminjam konsep daripada GitHub seperti cawangan dan bergabung untuk mengawal salinan induk dan mengurus sebarang konflik.

Anda boleh membuat draf baharu untuk menambahkan perubahan individu anda sendiri pada dokumentasi. Dalam draf, anda boleh membuat perubahan pada kandungan, serta menambah halaman baharu atau kumpulan halaman. Setelah anda selesai membuat perubahan anda, anda boleh menggabungkannya atau menyerahkannya untuk semakan.

saya tidak boleh masuk ke dalam facebook saya

Jika anda membuat dokumentasi dalaman untuk kod Java anda, anda mungkin mahu meneroka Javadoc. Javadoc membolehkan anda mendokumenkan kod Java anda secara automatik.