เอกสาร - ชุมชน - เอกสารนักพัฒนา - Changelog - รายงานข้อผิดพลาด
ยินดีต้อนรับสู่ Gitbook แพลตฟอร์มสำหรับการจัดการความรู้ด้านเทคนิคสำหรับทีม
ที่เก็บนี้มีรหัสโอเพนซอร์สที่ใช้ในการแสดงเนื้อหาที่เผยแพร่ของ Gitbook
เริ่มต้น
การบริจาค
ประเภทของผลงาน
การออกใบอนุญาต
กิตติกรรมประกาศ
Gitbook มรดก
หากต้องการเรียกใช้โครงการท้องถิ่นนี้โปรดทำตามขั้นตอนง่ายๆเหล่านี้
node.js (เวอร์ชัน:> = 18.x)
ขนมปัง
โคลน repo เป็นที่เก็บ GitHub สาธารณะ หากคุณวางแผนที่จะแจกจ่ายรหัสให้ให้ซอร์สโค้ดสาธารณะปฏิบัติตาม GNU GPLV3 หากต้องการโคลนในพื้นที่เก็บข้อมูลส่วนตัวได้รับใบอนุญาตเชิงพาณิชย์
git clone https://github.com/gitbookIO/gitbook.git
ตรวจสอบให้แน่ใจว่าคุณใช้ node
เวอร์ชันของโครงการ การใช้งาน nvm use
จะเปลี่ยนเวอร์ชันท้องถิ่นของคุณเป็นรุ่นที่ถูกต้อง
ติดตั้งการพึ่งพาของโครงการผ่าน BUN
bun install
เริ่มต้นเซิร์ฟเวอร์การพัฒนาในพื้นที่ของคุณ
bun dev
เปิดพื้นที่ gitbook ที่เผยแพร่ในเว็บเบราว์เซอร์ของคุณนำหน้าด้วย http://localhost:3000/
ตัวอย่าง:
http: // localhost: 3000/docs.gitbook.com
http: // localhost: 3000/open-source.gitbook.io/midjourney
ไซต์ gitbook ที่เผยแพร่ใด ๆ สามารถเข้าถึงได้ผ่านอินสแตนซ์การพัฒนาในพื้นที่ของคุณและการอัปเดตใด ๆ ที่คุณทำกับ codebase จะสะท้อนให้เห็นในเบราว์เซอร์ของคุณ
bun format
: จัดรูปแบบรหัส
bun lint
: ผ้าสำลี
การตอบกลับทั้งหมดจะถูกทดสอบทั้งการทดสอบภาพและการแสดงเพื่อป้องกันการถดถอย
เอ็นจิ้นการเรนเดอร์ของ Gitbook เป็นโอเพนซอร์สอย่างเต็มที่และสร้างขึ้นด้านบนของ Next.js. มุ่งหน้าไปยังคู่มือการสนับสนุนของเราเพื่อเรียนรู้เพิ่มเติมเกี่ยวกับเวิร์กโฟลว์ในการเพิ่มคำขอดึงครั้งแรกของคุณ
เราขอแนะนำให้คุณมีส่วนร่วมใน Gitbook เพื่อช่วยเราสร้างเครื่องมือที่ดีที่สุดสำหรับการบันทึกความรู้ด้านเทคนิค หากคุณกำลังมองหาวิธีที่รวดเร็วในการมีส่วนร่วมให้อ่านต่อเพื่อเรียนรู้เพิ่มเติมเกี่ยวกับการมีส่วนร่วมที่เป็นที่นิยม
Gitbook UI นั้นแสดงผลโดยใช้ชุดไฟล์การแปลที่พบใน packages/gitbook/src/intl/translations
เรายินดีต้อนรับการแปลเพิ่มเติมทั้งหมดสำหรับ UI
พบข้อผิดพลาดหรือค้นหาปัญหาที่คุณต้องการแก้ไข? ช่วยให้เราแก้ไขปัญหาที่เกี่ยวข้องกับ Gitbook ปรับปรุงประสบการณ์สำหรับทุกคนอย่างมาก มุ่งหน้าไปที่ส่วนปัญหาของที่เก็บนี้เพื่อเรียนรู้เพิ่มเติมเกี่ยวกับประเภทของข้อบกพร่องที่คุณสามารถช่วยได้แล้ว
คำเตือน
แม้ว่าจะเป็นไปได้ที่จะโฮสต์โครงการนี้ แต่เราไม่แนะนำสิ่งนี้เว้นแต่คุณจะมั่นใจว่าตัวเลือกนี้เหมาะกับความต้องการของคุณ
กำลังมองหาการเพิ่มคุณสมบัติเฉพาะใน Gitbook หรือไม่? มุ่งหน้าไปยังคู่มือการสนับสนุนของเราเพื่อเริ่มต้น
การโฮสต์ด้วยตนเองโครงการนี้มีความรับผิดชอบในการรักษาและรวมการอัปเดตในอนาคตกับ คุณ เราไม่สามารถรับประกันการสนับสนุนการบำรุงรักษาหรือการอัปเดตสำหรับอินสแตนซ์ของโครงการนี้
เราต้องการทำให้มันง่ายที่สุดเท่าที่จะเป็นไปได้สำหรับชุมชนของเราที่จะทำงานร่วมกันและผลักดันอนาคตของ Gitbook ซึ่งเป็นเหตุผลที่เราสนับสนุนให้คุณมีส่วนร่วมในผลิตภัณฑ์ของเราโดยตรงแทนที่จะสร้างเวอร์ชันของคุณเอง
โครงการนี้ช่วยให้คุณสามารถโฮสต์ส่วนการแสดงผลของเนื้อหาที่เผยแพร่ของ Gitbook ของคุณ การโฮสต์ตัวเองมีข้อดีและข้อเสีย
ในด้านมืออาชีพคุณสามารถปรับแต่งรูปลักษณ์และความรู้สึกของเนื้อหาของคุณและฝังเอกสารของคุณในแอปพลิเคชันของคุณได้ดีขึ้น
ในทางกลับกันคุณจะต้องรับผิดชอบต่อความน่าเชื่อถือของเว็บไซต์ที่ตีพิมพ์ของคุณและรักษาผู้แสดงผลที่ทันสมัยด้วยการเปลี่ยนแปลงที่เกิดขึ้นกับแพลตฟอร์ม Gitbook
แจกจ่ายภายใต้ใบอนุญาต GNU GPLV3
หากคุณวางแผนที่จะแจกจ่ายรหัสคุณต้องทำให้ซอร์สโค้ดสาธารณะเพื่อให้สอดคล้องกับ GNU GPLV3 หากต้องการโคลนในพื้นที่เก็บข้อมูลส่วนตัวได้รับใบอนุญาตเชิงพาณิชย์
ดู LICENSE
สำหรับข้อมูลเพิ่มเติม
[! [gitbook] (https://img.shields.io/static/v1?message=documented%20on%20Gitbook&logo=gitbook&logocolor=ffffff&label=%20&labelcolor=5c5c5c&color
<a href = "https://gitbook.com"> <imgsrc = "https://img.shields.io/static/v1?message=documented%20on%20gitbook&logo=gitbook&logocolor=FFFF&label=%20 " /> </a>
Gitbook จะเป็นไปไม่ได้หากไม่มีโครงการเหล่านี้:
next.js
ขนมปัง
tailwind css
การเคลื่อนไหวของ framer
Gitbook เวอร์ชันก่อนหน้าของเราและเครื่องมือ CLI ตอนนี้เลิกใช้แล้ว คุณยังสามารถดูพื้นที่เก็บข้อมูลเก่าและทำหน้าที่ในสาขานี้