blocksuite

blocksuite

คำเตือน

ที่เก็บนี้จะได้รับการเปลี่ยนแปลงที่สำคัญดังนั้นเราจะระงับการรับ PRS

อ่านเพิ่มเติม: #9045

---

ภาพรวม

คนที่จริงจังกับบรรณาธิการควรสร้างกรอบของตัวเอง

Blocksuite เป็นชุดเครื่องมือสำหรับการสร้างบรรณาธิการและแอพพลิเคชั่นการทำงานร่วมกัน มันใช้ชุดโครงสร้างพื้นฐานการแก้ไขเนื้อหาส่วนประกอบ UI และบรรณาธิการอย่างอิสระ

คุณสามารถพิจารณา Blocksuite เป็นไลบรารีส่วนประกอบ UI สำหรับการสร้างบรรณาธิการต่าง ๆ ตามกรอบวานิลลาที่ย่อเล็กสุดเป็นรันไทม์ของพวกเขา ด้วย blocksuite คุณสามารถ:

• นำบรรณาธิการบล็อกของบุคคลแรกกลับมาใช้ใหม่อีกครั้ง:
  • PageEditor : ตัวแก้ไขเอกสารที่ใช้บล็อกที่ครอบคลุมซึ่งเสนอการปรับแต่งและความยืดหยุ่นอย่างกว้างขวาง
  • EdgelessEditor : ตัวแก้ไขกราฟิกที่มีการรองรับการแสดงผลการเรนเดอร์แบบ opt-in canvas แต่ยังแบ่งปันความสามารถในข้อความที่หลากหลายเดียวกันกับ PageEditor
• ปรับแต่งขยายและปรับปรุงบรรณาธิการเหล่านี้ด้วยชุดส่วนประกอบและตัวอย่างบล็อก ส่วนประกอบของบล็อกทั้งหมด (รวมถึงบรรณาธิการ) เป็นส่วนประกอบของเว็บพื้นเมืองทำให้พวกเขาเป็นกรอบการทำงานที่ไม่เชื่อเรื่องง่ายและง่ายต่อการ interop กับเฟรมเวิร์กยอดนิยม
• หรือสร้างบรรณาธิการใหม่ตั้งแต่เริ่มต้นตามกรอบวานิลลาพื้นฐาน

- ปัจจุบัน Blocksuite อยู่ในช่วงเริ่มต้นโดยมีส่วนประกอบและความสามารถในการขยายยังคงอยู่ภายใต้การปรับแต่ง หวังว่าคุณจะติดตามความคืบหน้าลองหรือแบ่งปันความคิดเห็นของคุณ!

แรงจูงใจ

Blocksuite มีต้นกำเนิดมาจากฐานความรู้ Affine โดยมีเป้าหมายการออกแบบรวมถึง:

• การสนับสนุนสำหรับเนื้อหาที่สามารถแก้ไขได้หลายรูปแบบ : เมื่อพิจารณาความรู้เป็นแหล่งเดียวของความจริงการสร้างโหมดมุมมองที่หลากหลาย (เช่นข้อความสไลด์แผนที่จิตใจตาราง) ยังคงต้องใช้กรอบที่เข้ากันไม่ได้หลายเฟรม เป็นการดีที่ไม่ว่าการนำเสนอของการเปลี่ยนแปลงเนื้อหาควรมีกรอบที่สอดคล้องกันที่ช่วยได้
• การจัดระเบียบและการแสดงความรู้ที่ซับซ้อน : บรรณาธิการที่มีอยู่โดยทั่วไปจะมุ่งเน้นไปที่การแก้ไขเอกสารเดียว แต่มักจะสั้นในการจัดการกับโครงสร้างที่ซับซ้อนที่เกี่ยวข้องกับการอ้างอิงที่เชื่อมโยงกัน สิ่งนี้ต้องใช้กรอบการจัดการสถานะในหลาย ๆ เอกสาร
• การทำงานร่วมกันพร้อม : การทำงานร่วมกันแบบเรียลไทม์มักถูกมองว่าเป็นปลั๊กอินเสริม แต่ในความเป็นจริงเราสามารถใช้เทคโนโลยี CRDT พื้นฐานสำหรับการจัดการสถานะของบรรณาธิการซึ่งช่วยในการสร้างการไหลของข้อมูลที่ชัดเจนและเชื่อถือได้มากขึ้น

ในระหว่างการพัฒนาของเลียนแบบเป็นที่ชัดเจนว่า Blocksuite กำลังก้าวไปข้างหน้าเพียงแค่เป็นบรรณาธิการในบ้านและพัฒนาไปสู่กรอบการทำงานที่หลากหลาย นั่นเป็นเหตุผลที่เราเลือกที่จะโอเพนซอร์สและบำรุงรักษาบล็อกซึต์อย่างอิสระ

คุณสมบัติ

ด้วยบรรณาธิการ BlockSuite คุณสามารถเลือกใช้คุณสมบัติการแก้ไขทั้งหมดใน Affine:

และภายใต้ประทุนกรอบการทำงานของ Vanilla Blocksuite สนับสนุน:

• การกำหนดบล็อกที่กำหนดเองและการฝังแบบอินไลน์
• การอัปเดตที่เพิ่มขึ้นการทำงานร่วมกันแบบเรียลไทม์และการซิงโครไนซ์ข้อมูลแบบกระจายอำนาจตามกลไกการสตรีมเอกสารของเอกสาร
• การเขียนตรรกะการแก้ไขที่ซับซ้อนประเภทตามกลไกการสั่งซื้อคล้ายกับปฏิกิริยาเบ็ดที่ออกแบบมาสำหรับการแก้ไขเอกสาร
• การคงอยู่ของเอกสารและความเข้ากันได้กับรูปแบบบุคคลที่สามต่าง ๆ (เช่น markdown และ HTML) ขึ้นอยู่กับสแน็ปช็อตบล็อกและหม้อแปลง
• การกำหนดเวลาของรัฐในหลายเอกสารและนำเอกสารหนึ่งฉบับมาใช้ใหม่ในบรรณาธิการหลายตัว

หากต้องการลองใช้ blocksuite ให้ดูตัวอย่างเริ่มต้นอย่างรวดเร็วและเริ่มต้นด้วยตัวแก้ไขที่ตั้งไว้ล่วงหน้าใน @blocksuite/presets

สถาปัตยกรรม

ความสัมพันธ์ระหว่าง blocksuite และ affine นั้นคล้ายคลึงกับระหว่างตัวแก้ไขโมนาโกและ VSCODE แต่ด้วยความแตกต่างที่สำคัญอย่างหนึ่ง: blocksuite ไม่ได้สร้างขึ้นโดยอัตโนมัติตาม codebase affine แต่ได้รับการดูแลอย่างอิสระด้วยสแต็กเทคโนโลยีที่แตกต่างกัน

ความแตกต่างนี้ได้นำ blocksuite เพื่อกำหนดขอบเขตที่ชัดเจนตามปรัชญาส่วนประกอบเป็นศูนย์กลางเพื่อให้มั่นใจว่า:

• ทั้งแบบดัดแปลงและโครงการอื่น ๆ ควรนำกลับมาใช้ใหม่และขยายบล็อกซิวผ่านส่วนประกอบโดยไม่มีสิทธิพิเศษใด ๆ
• ส่วนประกอบของ Blocksuite สามารถนำกลับมาใช้ใหม่ได้อย่างง่ายดายโดยไม่คำนึงว่าคุณใช้ React หรือเฟรมเวิร์กอื่น ๆ

ด้วยเหตุนี้โครงการ BlockSuite จึงมีโครงสร้างรอบแพ็คเกจคีย์ที่แบ่งออกเป็นสองกลุ่ม: กรอบการทำงานแบบไม่มีหัวและส่วนประกอบการแก้ไข prebuilt

กรอบ
@blocksuite/store	เลเยอร์ข้อมูลสำหรับการสร้างแบบจำลองสถานะเอกสารความร่วมมือ มันถูกสร้างขึ้นโดยธรรมชาติบนห้องสมุด CRDT YJS ให้กำลังใจเอกสารบล็อกทั้งหมดทั้งหมดด้วยการทำงานร่วมกันแบบเรียลไทม์ในตัวและความสามารถในการเดินทางข้ามเวลา
@blocksuite/inline	ส่วนประกอบข้อความที่สมบูรณ์น้อยที่สุดสำหรับการแก้ไขแบบอินไลน์ Blocksuite ช่วยให้แยกเนื้อหาข้อความที่หลากหลายในโหนดบล็อกที่แตกต่างกันลงในตัวแก้ไขแบบอินไลน์ที่แตกต่างกัน สิ่งนี้จะช่วยลดความซับซ้อนที่จำเป็นในการใช้คุณสมบัติการแก้ไขข้อความที่หลากหลายแบบดั้งเดิม
@blocksuite/block-std	ห้องสมุดเฟรมเวิร์ก-อ้อยสำหรับการสร้างแบบจำลองบล็อกที่แก้ไขได้ ความสามารถของมันครอบคลุมโครงสร้างของฟิลด์บล็อกเหตุการณ์การเลือกการสนับสนุนคลิปบอร์ด ฯลฯ

ส่วนประกอบ
@blocksuite/blocks	การใช้งานบล็อกเริ่มต้นสำหรับการเขียนตัวแก้ไขที่ตั้งไว้ล่วงหน้ารวมถึงวิดเจ็ตที่เป็นของแต่ละบล็อก
@blocksuite/presets	ส่วนประกอบที่แก้ไขได้แบบปลั๊กและเล่นรวมถึง บรรณาธิการ ( PageEditor / EdgelessEditor ) และส่วนประกอบ UI เสริมชื่อ Fragments ( CopilotPanel , DocTitle ... )

ทรัพยากร

• - ทรัพยากร
  • สนามเด็กเล่นนกขมิ้น
  • ตัวอย่าง
  • blocksuite ใน stackblitz
  • การทดสอบการทำงานร่วมกันแบบเรียลไทม์
  • ระบบนิเวศของ Blocksuite CI
  • Editor blocksvite ที่ใช้ Vue
• เอกสาร
• - ปัญหาแรกที่ดี
• ? ️การอภิปราย GitHub
• ช่อง Discord
• ปล่อย

อาคาร

ดู Building.md สำหรับคำแนะนำเกี่ยวกับวิธีการสร้างและทดสอบบล็อกซึท์จากแหล่งที่มา

การบริจาค

Blocksuite ยอมรับคำขอดึงบน GitHub ก่อนที่คุณจะเริ่มมีส่วนร่วมโปรดตรวจสอบให้แน่ใจว่าคุณได้อ่านและยอมรับข้อตกลงใบอนุญาตผู้สนับสนุนของเรา เพื่อระบุข้อตกลงของคุณเพียงแก้ไขไฟล์นี้และส่งคำขอดึง

ใบอนุญาต

MPL 2.0