Markdown Preview
Live Markdown preview
Live Markdown preview يعمل محليا في المتصفح الخاص بك
About the
تعرض معاينة Markdown Markdown أثناء الكتابة، في عرض جنبًا إلى جنب، باتباع CommonMark مع ملحقات GitHub التي يستخدمها معظم الأشخاص فعليًا: الجداول، وقوائم المهام، وكتل التعليمات البرمجية المسيجة، ويتوسطه خط والارتباطات التلقائية. إنها أسرع طريقة للتحقق من الملف README قبل تنفيذه، لأن الاختلافات بين ما يبدو عليه Markdown في المصدر وما يبدو عليه معروضًا ليست واضحة، ويفشل بناء جملة الجدول على وجه الخصوص بصمت عندما يكون هناك خطا واحد أو شرطة واحدة. يمكن أيضًا نسخ HTML المعروض إذا كنت في حاجة إليه في مكان لا يعالج Markdown نفسه.
Where people use the
- التحقق من عرض ملف README بشكل صحيح قبل دفعه.
- صياغة ملاحظات الإصدار أو سجل التغيير مع عرض مباشر للنتيجة.
- تحويل مستند Markdown إلى HTML لنظام إدارة محتوى لا يقبل Markdown.
- مراجعة طلب سحب Markdown الخاص بشخص آخر ومعرفة الشكل الذي سيبدو عليه.
How to use the
- 1
الصق أو اكتب Markdown الخاص بك
يقبل المحرر أي شيء بدءًا من فقرة واحدة وحتى مستند كامل يحتوي على عناوين وقوائم وروابط وأسوار برمجية.
- 2
شاهد اللوحة المقدمة
يتم تحديث المعاينة عند كل ضغطة على المفتاح، لذلك يظهر جدول مكسور أو سياج غير مغلق على الفور وليس بعد خطوة النشر.
- 3
أصلح المصدر وليس المعاينة
المعاينة للقراءة فقط. عندما يتم عرض شيء ما بشكل خاطئ، يكون السبب دائمًا هو وجود سطر فارغ مفقود قبل القائمة أو رأس جدول بدون صف محدد.
- 4
انسخ HTML إذا كنت في حاجة إليه
قم بالتبديل إلى عرض HTML للحصول على الترميز الذي تم إنشاؤه، وهو أمر مفيد للصقه في نظام إدارة المحتوى الذي يتوقع HTML بدلاً من Markdown.
النصائح وأفضل الممارسات
- اترك سطرًا فارغًا قبل وبعد كل عنصر كتلة؛ معظم أخطاء العرض المحيرة هي سطر فارغ مفقود.
- استخدم كتل التعليمات البرمجية المسيجة مع اسم اللغة بحيث يتم تمييز الرمز بدلاً من التعامل معه كنص عادي.
- احتفظ بجملة واحدة في كل سطر في المستندات الطويلة؛ يجعل الاختلافات قابلة للقراءة لاحقًا.
الأسئلة المتداولة
ما هي مواصفات Markdown المستخدمة؟
CommonMark كقاعدة، بالإضافة إلى ملحقات GitHub Flavoured Markdown للجداول وقوائم المهام والتعليمات البرمجية المسيجة ويتوسطه خط. يغطي هذا المزيج تنسيق README على GitHub وGitLab ومعظم مواقع التوثيق.
لماذا لا يتم عرض الجدول الخاص بي؟
يحتاج الجدول إلى صف رأس يتبعه مباشرة صف محدد من الشرطات، مع سطر فارغ قبل الكتلة. يجب أن يحتوي كل صف على نفس عدد الأنابيب الموجودة في الرأس. أي واحد من هؤلاء المفقودين يحول كل شيء إلى فقرة من النص تحتوي على أحرف توجيهية.
لماذا تم دمج عناصر قائمتي في فقرة واحدة؟
يحتاج Markdown إلى سطر فارغ بين الفقرة والقائمة التي تليها. وبدون ذلك، يتم التعامل مع علامات القائمة كنص عادي.
هل يدعم LaTeX أو الرياضيات؟
لا. يحتاج عرض الرياضيات إلى مكتبة منفصلة مثل KaTeX أو MathJax وصياغة مختلفة. سيتم عرض تعبير علامة الدولار هنا كنص عادي.
هل يُسمح باستخدام HTML الخام؟
نعم، يمر HTML المضمّن مباشرة، وهو ما يفعله GitHub أيضًا. إذا قمت بنشر الإخراج في أي مكان عام، فقم بتطهيره أولاً، لأن HTML الخام هو أيضًا كيفية إدخال البرامج النصية.
أين يذهب النص الخاص بي؟
في أي مكان. يتم التحليل والعرض في متصفحك باستخدام مكتبة JavaScript Markdown. لا يتم حفظ أي شيء أو نقله، لذا تختفي المسودة عند إغلاق علامة التبويب ما لم تقم بنسخها.