blocksuite

Blocksuite

تحذير

سيخضع هذا المستودع لتغييرات كبيرة ، لذلك سنعلق قبول PRS.

اقرأ المزيد: #9045

---

ملخص

يجب على الأشخاص الجادين حقًا في المحرر أن يصنعوا إطارهم الخاص.

Blocksuite هي مجموعة أدوات لبناء المحررين والتطبيقات التعاونية. وهو ينفذ سلسلة من البنى التحتية لتحرير المحتوى ومكونات واجهة المستخدم والمحررين بشكل مستقل.

يمكنك النظر في Blocksuite كمكتبة مكونات واجهة المستخدم لبناء العديد من المحررين ، استنادًا إلى إطار عمل الفانيليا الصحيح مثل وقت التشغيل. مع blocksuite ، يمكنك:

• إعادة استخدام محرري Locksuite في الطرف الأول المتعدد:
  • PageEditor : محرر مستندات شامل قائم على كتلة ، يقدم تخصيصًا ومرونة شاملة.
  • EdgelessEditor : محرر رسومات مع دعم لتقديم Canvas ، ولكنه يشارك أيضًا نفس إمكانيات النص الغني مع PageEditor .
• تخصيص وتوسيع وتعزيز هؤلاء المحررين بمجموعة غنية من مكونات ومكونات ومتأمين. جميع مكونات blocksuite (بما في ذلك المحررين) هي مكونات ويب أصلية ، مما يجعلها مغنية بالإطار وسهلة التواصل مع الأطر الشعبية.
• أو ، قم ببناء محررين جدد من نقطة الصفر بناءً على إطار الفانيليا الأساسي.

؟ تقع Blocksuite حاليًا في مرحلتها المبكرة ، حيث لا تزال المكونات وقدرات التمديد تحت التنقيح. آمل أن تتمكن من البقاء على ضبطها أو تجربتها أو مشاركة ملاحظاتك!

تحفيز

نشأت Blocksuite من قاعدة المعرفة Affine ، مع أهداف التصميم بما في ذلك:

• الدعم للمحتوى القابل للتحرير متعدد الوسائط : عند النظر في المعرفة كمصدر واحد للحقيقة ، فإن بناء أوضاع العرض المختلفة (على سبيل المثال ، النص ، الشرائح ، خرائط العقل ، الجداول) لا تزال تتطلب أطراف متعددة غير متوافقة. من الناحية المثالية ، بغض النظر عن كيفية تغيير المحتوى ، يجب أن يكون هناك إطار ثابت يساعد.
• تنظيم وتصور المعرفة المعقدة : يركز المحررين الحاليون عمومًا على تحرير المستندات الفردية ، ولكن غالبًا ما يكونون مختصرين في التعامل مع الهياكل المعقدة التي تنطوي على مراجع متشابكة. وهذا يتطلب إطار العمل لإدارة الدولة أصليًا عبر مستندات متعددة.
• استعداد التعاون : غالبًا ما يُنظر إلى التعاون في الوقت الفعلي على أنه مكون إضافي اختياري ، ولكن في الواقع ، يمكننا استخدام تقنية CRDT الأساسية لإدارة حالة المحرر ، مما يساعد على بناء تدفق بيانات أوضح وأكثر موثوقية.

أثناء تطوير Affine ، أصبح من الواضح أن Locksuite كان يتقدم إلى ما وراء مجرد كونه محررًا داخليًا ويتطور إلى إطار متعدد الاستخدامات. لهذا السبب اخترنا فتح المصدر والحفاظ على blocksuite بشكل مستقل.

سمات

مع محرري Blocksuite ، يمكنك إعادة استخدام جميع ميزات التحرير بشكل انتقائي في Affine:

وتحت الغطاء ، يدعم إطار عمل الفانيليا:

• تحديد الكتل المخصصة والتضمينات المضمنة.
• التحديثات الإضافية ، والتعاون في الوقت الفعلي ، وحتى مزامنة البيانات اللامركزية بناءً على آلية تدفق المستندات للوثيقة.
• كتابة منطق التحرير المعقد الذي آمن نوعًا ما بناءً على آلية الأوامر ، على غرار خطافات React المصممة لتحرير المستندات.
• استمرار الوثائق والتوافق مع مختلف تنسيقات الطرف الثالث (مثل Markdown و HTML) على أساس لقطة كتلة ومحول.
• جدولة الدولة عبر مستندات متعددة وإعادة استخدام مستند واحد في العديد من المحررين.

لتجربة blocksuite ، راجع مثال البداية السريعة وابدأ مع المحررين المسبق في @blocksuite/presets .

بنيان

تشبه العلاقة بين blocksuite و Affine تلك بين محرر Monaco و VSCODE ، ولكن مع اختلاف رئيسي واحد: لا يتم إنشاء blocksuite تلقائيًا استنادًا إلى قاعدة كود Affine ، ولكن يتم الحفاظ عليها بشكل مستقل مع مجموعة تقنية مختلفة - تستخدم Affine React بينما تستخدم Blocksite مراهنات الويب.

لقد أدى هذا الاختلاف إلى LED LODSUITE لتعيين حدود واضحة بناءً على فلسفة تتمحور حول المكون ، مما يضمن:

• يجب على كل من المشاريع والمشاريع الأخرى إعادة استخدام وتوسيع الكتل من خلال المكونات ، دون أي امتيازات.
• يمكن إعادة استخدام مكونات blocksuite بسهولة بغض النظر عما إذا كنت تستخدم React أو أطر أخرى.

تحقيقًا لهذه الغاية ، يتم تنظيم مشروع blocksuite حول الحزم الرئيسية التي يتم تصنيفها إلى مجموعتين: إطار عمل مقطوع الرأس ومكونات التحرير المسبقة.

نطاق
@blocksuite/store	طبقة البيانات لنمذجة حالات المستندات التعاونية. تم تصميمه أصليًا على مكتبة CRDT YJS ، حيث يعمل على تشغيل جميع مستندات Blocksuite مع إمكانيات التعاون في الوقت الفعلي المدمج وقدرات السفر عبر الزمن.
@blocksuite/inline	الحد الأدنى من مكونات النص الغنية للتحرير المضمّن. يسمح BlockSuite بربط محتوى النص الغني في عقد كتلة مختلفة في محررين مختلفين مضمنين ، مما يجعل المحتوى المعقد قابلاً للتأليف بشكل مناسب. هذا يقلل بشكل كبير من التعقيد المطلوب لتنفيذ ميزات تحرير النصية الغنية التقليدية.
@blocksuite/block-std	مكتبة إطار عمل لاذعة لنمذجة الكتل القابلة للتحرير. تغطي قدراتها بنية حقول الكتلة والأحداث والاختيار ودعم الحافظة ، إلخ.

عناصر
@blocksuite/blocks	تطبيقات الكتلة الافتراضية لتأليف المحررين مسبقًا ، بما في ذلك الحاجيات التي تنتمي إلى كل كتلة.
@blocksuite/presets	المكونات القابلة للتحرير المكونات والتشغيل بما في ذلك المحررين ( PageEditor / EdgelessEditor ) ومكونات واجهة المستخدم الإضافية المسمى شظايا ( CopilotPanel ، DocTitle ...).

موارد

• ؟ موارد
  • ملعب كناري
  • أمثلة
  • Blocksuite في Stackblitz
  • اختبار التعاون في الوقت الفعلي
  • Blocksuite Ecosystem CI
  • محرر BlockSvite المستند إلى VUE
• الوثائق
• ؟ القضايا الأولى الجيدة
• مناقشات جيثب
• قناة Discord
• الإصدارات

مبنى

انظر Building.md للحصول على تعليمات حول كيفية بناء واختبار الكتل من المصدر.

المساهمة

تقبل BlockSuite طلبات السحب على Github. قبل البدء في المساهمة ، يرجى التأكد من أنك قد قرأت اتفاقية ترخيص المساهم وقبلتها. للإشارة إلى اتفاقك ، ما عليك سوى تحرير هذا الملف وإرسال طلب سحب.

رخصة

MPL 2.0