Marked Documentation

ما هو

Marked هو مُحلل ومُحوِّل Markdown عالي الأداء لجافاسكريبت. صُمم لتحقيق السرعة والكفاءة، مما يجعله مثاليًا للتطبيقات التي تتطلب عرض Markdown في الوقت الفعلي دون عبء أداء كبير. على عكس بعض البدائل التي تعتمد على التخزين المؤقت أو معالجات DOM المعقدة، يركز Marked على التحليل المباشر، مما يوفر حلاً خفيف الوزن. يوفر واجهة برمجة تطبيقات (API) بسيطة، وخيارات تخصيص واسعة من خلال الإضافات، ويدعم ميزات Markdown الشائعة. سيجد المطورون الذين يحتاجون إلى دمج دعم Markdown في مشاريعهم، مثل أنظمة إدارة المحتوى، أو مُنشئات المواقع الثابتة، أو محررات النصوص، أن Marked أداة قيمة. إن تركيزه على السرعة والمرونة يجعله مناسبًا للعرض من جانب العميل والخادم.

الميزات الأساسية

تحليل عالي الأداء

يعطي Marked الأولوية للسرعة من خلال استخدام مُحوِّل markdown منخفض المستوى. يتجنب آليات التخزين المؤقت التي يمكن أن تقدم زمن وصول، مما يضمن التحليل السريع لنص markdown. تُظهر الاختبارات المعيارية قدرته على معالجة مستندات markdown الكبيرة بشكل أسرع بكثير من البدائل، مما يجعله مناسبًا للتطبيقات في الوقت الفعلي ومعالجة المحتوى على نطاق واسع. تم تحسين منطق التحليل الأساسي لتحقيق الكفاءة، وتقليل استهلاك الموارد.

عرض قابل للتخصيص

يوفر Marked خيارات تخصيص واسعة من خلال نظام العرض والإضافات الخاص به. يمكن للمطورين تعديل ناتج HTML عن طريق تجاوز قواعد العرض الافتراضية للعناصر مثل العناوين والفقرات والروابط. يتيح ذلك التحكم الكامل في مظهر وسلوك markdown المعروض، مما يتيح التكامل السلس مع أنظمة التصميم الموجودة ومتطلبات التنسيق المخصصة. يتيح استخدام الخطافات مزيدًا من التخصيص.

هيكل قابل للتوسيع

تعد قابلية توسيع Marked نقطة قوة رئيسية، مما يسمح للمطورين بإضافة دعم لبناء جملة markdown مخصصة أو تعديل السلوك الحالي. يتم تحقيق ذلك من خلال استخدام الإضافات، والتي يمكن دمجها بسهولة في عملية التحليل. يتيح هذا التصميم المعياري المرونة والتكيف مع احتياجات المشروع المحددة، مثل دعم التوجيهات المخصصة أو التكامل مع خدمات الجهات الخارجية. تُستخدم طريقة `marked.use()` لتكامل الإضافة.

خفيف الوزن والحد الأدنى من التبعيات

تم تصميم Marked ليكون خفيف الوزن، مع الحد الأدنى من التبعيات. هذا يقلل من الحجم الإجمالي للمكتبة ويقلل من التأثير على أداء التطبيق. يضمن عدم وجود تبعيات معقدة إمكانية دمج Marked بسهولة في بيئات مختلفة، بما في ذلك تطبيقات الويب من جانب العميل ومشاريع Node.js من جانب الخادم. هذا يجعله سهل النشر والصيانة.

دعم GFM

يتضمن Marked دعمًا مدمجًا لـ GitHub Flavored Markdown (GFM)، مما يتيح ميزات مثل قوائم المهام والجداول وكتل التعليمات البرمجية المسورة. يضمن هذا التوافق مع مجموعة واسعة من بناء جملة markdown المستخدمة بشكل شائع في التطوير والتوثيق. يتم تمكين دعم GFM عبر خيار بسيط، مما يسهل دمج هذه الميزات في عرض markdown الخاص بك.

اعتبارات الأمان

يوفر Marked خيارات لتنظيف ناتج HTML، مما يخفف من نقاط الضعف الأمنية المحتملة. هذا أمر بالغ الأهمية عند معالجة المحتوى الذي ينشئه المستخدم، ومنع هجمات البرمجة النصية عبر المواقع (XSS). يمكن للمطورين تكوين Marked لإزالة علامات وسمات HTML الخطرة المحتملة، مما يضمن سلامة تطبيقاتهم. توفر المكتبة التحكم في كيفية التعامل مع HTML.

كيفية الاستخدام

قم بتضمين مكتبة Marked في مشروعك عبر علامة <script> أو عن طريق تثبيتها باستخدام npm: npm install marked.,2. استورد Marked في ملف JavaScript الخاص بك: import { marked } from 'marked'; أو const { marked } = require('marked');.,3. استخدم الدالة marked() لتحويل نص markdown إلى HTML: const html = marked('# Hello, Marked!');.,4. خصص العرض باستخدام الخيارات. على سبيل المثال، لتمكين GFM (GitHub Flavored Markdown): const html = marked(markdownText, { gfm: true });.,5. قم بتوسيع Marked باستخدام أدوات العرض أو الإضافات المخصصة للتعامل مع بناء جملة Markdown أو متطلبات التنسيق المحددة.,6. اعرض HTML الذي تم إنشاؤه في صفحة الويب الخاصة بك عن طريق تعيين innerHTML لعنصر HTML: document.getElementById('content').innerHTML = html;

حالات الاستخدام

أنظمة إدارة المحتوى (CMS)

يستخدم مطورو CMS Marked لتمكين المستخدمين من كتابة المحتوى في markdown، والذي يتم بعد ذلك عرضه إلى HTML للعرض على موقع الويب. يتيح ذلك إنشاء المحتوى وتنسيقه بسهولة أكبر، حيث أن markdown أسهل في الكتابة من HTML. يستفيد CMS من مُحلل markdown سريع وموثوق به يتكامل بسلاسة في سير عمل المحتوى.

مُنشئات المواقع الثابتة (SSG)

يستفيد مستخدمو SSG من Marked لتحويل ملفات markdown إلى HTML أثناء عملية الإنشاء. هذا ضروري لإنشاء مواقع ويب ثابتة من محتوى markdown. تعد سرعة وكفاءة Marked أمرًا بالغ الأهمية لأوقات الإنشاء السريعة، خاصة بالنسبة للمواقع التي تحتوي على عدد كبير من الصفحات. يضمن هذا عملية نشر سريعة وفعالة.

محررات النصوص وتطبيقات تدوين الملاحظات

يقوم مطورو محررات النصوص وتطبيقات تدوين الملاحظات بدمج Marked لتوفير وظيفة معاينة markdown في الوقت الفعلي. يمكن للمستخدمين الكتابة في markdown ورؤية ناتج HTML المنسق على الفور. هذا يحسن تجربة الكتابة من خلال توفير ملاحظات مرئية فورية. تعد سرعة Marked ضرورية لواجهة مستخدم سريعة الاستجابة وسلسة.

منصات التوثيق

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

من يستفيد

مُطوِّرو الويب

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

مُنشئو المحتوى

يستفيد مُنشئو المحتوى من Marked من خلال القدرة على الكتابة في markdown، وهي لغة ترميز بسيطة وفعالة. يتيح لهم ذلك التركيز على إنشاء المحتوى دون الانشغال بتنسيق HTML. يوفر Marked طريقة سريعة وموثوقة لتحويل markdown الخاص بهم إلى HTML للنشر.

مؤلفو التوثيق

يستخدم مؤلفو التوثيق Marked لعرض التوثيق المستند إلى markdown. يوفر طريقة مباشرة لتنسيق وعرض التوثيق الفني، مما يسهل قراءته وصيانته. تتيح خيارات التخصيص التنسيق المتسق والتكامل مع منصات التوثيق الحالية.

مُطوِّرو CMS و SSG

يعتمد مطورو منصات CMS و SSG على Marked لتوفير دعم markdown داخل تطبيقاتهم. يوفر طريقة سريعة وموثوقة لتحليل وعرض محتوى markdown، مما يمكّن المستخدمين من إنشاء المحتوى وإدارته بكفاءة. تتيح مرونة المكتبة التكامل السلس.

المزيد من الأدوات المشابهة مثل