اكتب Markdown بما يناسب المنصة التي ستنشره
يبدو Markdown موحداً إلى أن ينتقل المستند بين مستودع برمجي ومولّد مواقع ثابتة وقاعدة معرفة. يحدد CommonMark أساساً موثوقاً للفقرات والعناوين والقوائم والروابط والتأكيد والشيفرة، بينما تستطيع المنصات إضافة امتداداتها الخاصة. يضيف GitHub Flavored Markdown مثلاً الجداول وقوائم المهام والشطب والروابط التلقائية الموسعة. لذلك تجيب المعاينة المفيدة عن سؤالين: هل المصدر مقروء، وهل تعرض اللهجة المختارة البنى كما تقصد؟
تعامل مع المحرر كمنصة لاختبار قابلية النقل، لا كسطح كتابة مزخرف. أبقِ المصدر والمعاينة ظاهرين معاً، واعزل البنية المشكوك فيها، واختبرها بأصغر مثال يمكن أن يفشل. تحتاج البيانات الأمامية والحواشي والمخططات وHTML الخام والمكونات المخصصة إلى انتباه خاص لأنها غالباً تأتي من المنصة المستضيفة لا من Markdown الأساسي. وبعد نجاح المعاينة المحلية، يبقى فحص الملف في وجهته الفعلية هو العادة الأكثر أماناً قبل النشر.
أداة تحرير ومعاينة Markdown: الطريقة والافتراضات
ابدأ بالبنية الدلالية: تسلسل واضح للعناوين، وفقرات قصيرة، وقوائم متداخلة بصورة صحيحة، وروابط وصفية، وكتل شيفرة مسيجة مع اسم اللغة عند الحاجة. ثم افحص العرض بحثاً عن قوائم انقطعت دون قصد أو علامات ترقيم اختفت أو HTML خام غير آمن أو سياج شيفرة انتهى مبكراً. وأخيراً ميّز في ملاحظاتك بين CommonMark القابل للنقل وميزات GFM أو المنصة فقط. بهذه الجولات الثلاث يصبح اختلاف العرض قابلاً للتشخيص بدلاً من تحويل المستند كله إلى تجارب عشوائية.
يمثل CommonMark المرجع للقواعد الأساسية المستخدمة هنا، بينما تمثل مواصفة GitHub Flavored Markdown المرجع للجداول وامتدادات GFM الأخرى. وكل ميزة لا تظهر في المواصفتين ينبغي توثيقها كسلوك خاص بالوجهة.
مثال قابل للتحقق باستخدام أداة تحرير ومعاينة Markdown
أنشئ ملف README صغيراً فيه عنوان بعلامة #، وقائمة مهام من عنصرين، وكتلة JavaScript مسيجة، ورابط يحتوي مساره على أقواس، وجدول بعمودين. عاينه ثم انسخ المصدر نفسه إلى المستودع أو نظام إدارة المحتوى المقصود. يختبر العنوان والقائمة العادية وسياج الشيفرة والرابط أساس CommonMark، بينما تختبر مربعات المهام والجدول امتدادات GFM. أضف بيانات YAML الأمامية بعد هذه المقارنة، فقد تعرض المعاينة الشرطات كفاصل أفقي بينما يفسرها مولّد الموقع كبيانات وصفية.
فحص قابلية النقل = صيغة أساسية + امتدادات معلنة + اختبار الوجهة. نجاح المعاينة المحلية يثبت سلوك هذا العارض فقط، أما التطابق مع الوجهة فيؤكد أن المستند قابل للنشر دون مفاجأة في اللهجة.
مواضع تحتاج إلى عناية إضافية في أداة تحرير ومعاينة Markdown
لا تعمل شرطة الهروب الخلفية بالطريقة نفسها داخل كل بنية، وقد يقسم رمز الأنبوب الحرفي خلية جدول GFM إن لم يُهَرَّب. ويمكن للإزاحة أن تحول النثر إلى شيفرة أو تضع المحتوى داخل عنصر قائمة خاطئ. قد يعرض مضيف HTML الخام، بينما ينظفه مضيف آخر أو يعطله كلياً. كما قد تجعل الصور البعيدة مستنداً محلياً يطلب خادماً خارجياً. لا تستطيع المعاينة اعتماد التنظيف الأمني أو سهولة الوصول أو سلامة الروابط أو خطوط قالب الإنتاج.
راجع شريط الحالة الملون والعناوين والروابط والجداول وقوائم المهام وFrontmatter وكتل الشيفرة الطويلة قبل التنزيل. وانتبه إلى خطأ متكرر: استخدام أدوات التنسيق دون تحديد النص المقصود أو افتراض أن كل منصة تدعم إضافات GFM نفسها.
فحوص قبل اعتماد النتيجة
- ملاحظات Markdown والتوثيق ونصوص README وFrontmatter وجداول GFM وقوائم المهام والروابط وكتل الشيفرة.
- راجع شريط الحالة الملون والعناوين والروابط والجداول وقوائم المهام وFrontmatter وكتل الشيفرة الطويلة قبل التنزيل.
- قد تتصرف إضافات Markdown الخاصة بالمنصات والصور البعيدة بصورة مختلفة في المنصة المستهدفة.
- استخدم مساحة العمل المقسمة بعرض كامل للتحرير الطويل، ثم نزّل ملف .md النهائي واحتفظ به مع المشروع أو سير عمل الوكيل الذي يدعمه.
- استخدم مولد الجداول للصفوف المنظمة ومولد تعليمات الوكلاء للقوالب.
مصادر أداة تحرير ومعاينة Markdown
- مواصفة CommonMark 0.31.2
CommonMark
يعرّف قواعد كتل Markdown ومحتواها السطري القابلة للنقل، ويوثق أسباب اختلاف التطبيقات عند وجود مصدر ملتبس.
- مواصفة GitHub Flavored Markdown
GitHub
يعرّف امتدادات GFM ومنها الجداول وقوائم المهام، وقواعد الفواصل والمحاذاة وتحليل الخلايا والهروب داخل الجداول.
استخدم أداة تحرير ومعاينة Markdown من TOOLFINA
الصق Markdown أو اكتبه في المحرر، واستخدم إجراءات التنسيق فقط عندما تحافظ على المصدر المقصود، وقارن كل تغيير بالمعاينة. انسخ المصدر أو نزّله بعد اختبار الروابط والقوائم وكتل الشيفرة وأي امتداد GFM تدعمه وجهتك.
المدخلات: مصدر Markdown وإجراءات تنسيق اختيارية وأي بنى خاصة بالمنصة تريد اختبارها. المخرجات: مستند مصدر قابل للتحرير ومعاينة منسقة وإحصاءات للمستند وإجراءات نسخ أو تنزيل. النتيجة ليست صفحة منشورة ولا تحاكي كل مضيف.
يبقى Markdown داخل المتصفح أثناء التحرير والمعاينة. يضيف إدراج كتل Markdown جاهزة، ويبدّل تنسيق الصيغة القابلة للنقل على النص المحدد، ويتتبع التراجع والإعادة التعديلات، ثم يتحول المصدر إلى معاينة GFM.
جرّب هذه الأداة
اكتب وراجع Markdown بتنسيق قابل للتبديل وتراجع وإعادة ومعاينة GFM مباشرة وتحرير بملء الشاشة وتنزيل بصيغة .md.
محرر ومعاينة Markdown