تعلم Markdown: أداة الكتابة لمطوري البرامج

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

ودعنا نتذكر أنك تقني ، لذلك قد يكون محررو WYSIWYG الخيار الأفضل لك وقد لا يكون كذلك. لا تريد بالضرورة (أو حتى الإعجاب!) التنقل بين القوائم وأشرطة الأدوات والأشرطة لتنسيق النص الخاص بك.

فماذا لو ، بدلاً من ذلك ، يمكنك بسهولة إضافة جميع أنماط التنسيق الخاصة بك إلى النص مباشرةً مثل بناء جملة مضمّن بسيط لإنتاج نص منسق بالكامل؟

حسنًا ، في الواقع ، يمكنك ذلك. هذا هو Markdown وهذا ما يدور حوله هذا البرنامج التعليمي.

عندما يكون الكثير أقل ...

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

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

في الواقع ، يمكن أن يكون المزيد أحيانًا أقل عندما يتعلق الأمر بسهولة الاستخدام والإنتاجية.

... وعندما يكون الأقل أكثر

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

أدخل Markdown.

ما هو Markdown؟

أنشأ John Gruber (بمساهمات كبيرة من المعلم التقني والناشط على الإنترنت آرون شوارتز) لغة Markdown في عام 2004 بهدف تمكين الأشخاص "من الكتابة باستخدام تنسيق نص عادي سهل القراءة والكتابة ، وبشكل اختياري تحويلها إلى XHTML (أو HTML) صالح هيكليا ".

تم تصميم Markdown ليكون قابلاً للقراءة كما هو ، دون أن يبدو أنه قد تم ترميزه بالعلامات أو إرشادات التنسيق (على عكس النص المنسق بلغة ترميزية مثل RTF أو HTML والتي قد يكون من الصعب تأليفها ويصعب قراءتها بتنسيقها الأولي ).

يسمح لك Markdown بالكتابة باستخدام تنسيق نص عادي سهل القراءة والكتابة ، ويمكن تحويله بعد ذلك إلى HTML صالح هيكليًا. لذا ، لكي أكون دقيقًا تمامًا ، فإن Markdown عبارة عن شيئين حقًا:

1. صيغة تنسيق نص عادي
2. أداة برمجية (تمت كتابة الإصدار الأول منها بلغة Perl) تقوم بتحويل تنسيق النص العادي إلى HTML.

يتضمن Markdown عددًا قليلاً من الاصطلاحات النحوية البسيطة والبديهية إلى حد ما وسهلة الاستخدام. خاصة بالنسبة لك كمهندس برمجيات - الذي لا يتم تأجيله بالحاجة إلى التعلم واستخدام هذه الاصطلاحات الأساسية في بناء الجملة - يمكن أن يكون Markdown بالفعل هو الطريق الأقل مقاومة بين ما تريد كتابته وكتابته.

تعلم Markdown: الشروع في العمل

Markdown سهل التعلم. سهل للغاية. يمكنك تعلم الأساسيات في خمس دقائق وسوف تصبح طبيعة ثانية بسرعة. و - تمامًا مثل العلاقة بين معالجات CSS و CSS الأولية - يمكنك استخدام القليل أو بقدر ما تريد.

إذا كنت معتادًا على أي نوع من اصطلاحات كتابة النص العادي ، فقد تكون بالفعل على دراية ببعض اصطلاحات التخفيضات ، مثل الأرقام أو الشرطات في بداية الجملة لإنشاء قائمة وعلامات نجمية حول كلمة للتأكيد ، وهكذا على. لذلك ، على سبيل المثال ، إذا كنت ترغب في عرض شيء ما بخط مائل ، فقم ببساطة بلفه بعلامات نجمية مثل *this* (على عكس بناء جملة HTML غير المستقر مثل <span>this</span> ).

وبالمثل ، يمكنك تحديد عنوان H1 ببساطة عن طريق إضافة بادئة "#" إلى السطر الخاص بك (على سبيل المثال ، # Section Heading ، بدلاً من <h1>Section Heading</h1> ).

استخدام آخر رائع لتعلم Markdown ، خاصة بالنسبة لمهندسي البرمجيات ، هو استخدامه للتوثيق في مستودعات الكود المصدري. تتضمن معظم مستودعات إعادة الشراء ملف README.md ( .md هو الامتداد القياسي لملف Markdown). Github ، على سبيل المثال ، لديها "Markdown بنكهة Github" الخاصة بها ، والتي تضيف وظائف إضافية خاصة لوثائق التطوير. يمكن أن يوفر هذا الوقت بالتأكيد فوق الحاجة إلى كتابة هذه الوثائق بتنسيق HTML.

كمثال بسيط ، لنفترض أنك تريد تضمين المقتطف التالي في وثائقك:

<h2 style = color: # 3863a0؛ font-size: 1.5em؛ font-weight: 600؛ margin-top: 2em؛ margin-bottom: 1em؛ line-height: 1.3em؛> بدء المكوّنات الإضافية </ h2>

ابدأ pluginName في الحاوية الخاصة بك باستخدام jQuery على النحو التالي:

$(function() { $('#container').pluginName(); }); باستخدام معرف الحاوية الخاص بنا ، يمكننا بدء اسم المكون الإضافي باستخدام طريقة jQuery pluginName .pluginName() .

فيما يلي مقارنة لكيفية إجراء ذلك في HTML مقابل Markdown:

للحصول على مزيد من المساعدة للبدء ، هناك العديد من دروس Markdown عبر الإنترنت لمساعدتك في الحصول على أحدث المعلومات بما في ذلك نظرة عامة على Markdown بواسطة John Gruber (منشئ Markdown) بالإضافة إلى برنامج تعليمي Markdown عبر الإنترنت.

محلل أدوات ماركداون وأدوات

بمجرد كتابة مقالتك في Markdown ، ستحتاج إلى تطبيق لتحليل بناء الجملة إلى HTML. هناك عدد قليل من البرامج الرائعة المجانية بما في ذلك:

• StackEdit - محرر Markdown قائم على المتصفح ولديه عدد قليل من خيارات المزامنة مع الخدمات الشائعة مثل Google Drive و Dropbox
• Online Kramdown Editor - محرر Markdown آخر قائم على المستعرض بواجهة بسيطة للغاية
• Mou - أفضل كاتب Markdown على نظام Mac صادفته كخيار غريب الأطوار للمطورين ؛ الكثير من الميزات والمجانية (أثناء فترة تجريبية) [هذا ما اعتدت عليه لكتابة هذه المقالة]
• MarkdownPad - محرر Markdown رائع لنظام التشغيل Windows
• النصوص - محرر لطيف متعدد المنصات (Mac و Windows) ؛ يصدر إلى تنسيقات متعددة مثل PDF و .doc و ePub

اعتمدت بعض المنصات الرئيسية بالفعل (أو على الأقل سمحت) باستخدام Markdown في محرريها لأولئك الذين يرغبون في استخدامه. مع الآخرين ، مثل WordPress و Evernote و Google Docs ، لم يتم تقديم الدعم المحلي (في وقت كتابة هذا المقال) بعد ، ولكن تم تقديم حلول مخصصة من قبل أطراف ثالثة. وتشمل هذه:

• منصة التدوين الجديدة الشهيرة Ghost ، في سعيها لتبسيط الكتابة عبر الإنترنت ، تستخدم Markdown لمحرر المحتوى الخاص بها.
• بالنسبة إلى WordPress ، يدعم المكون الإضافي Jetpack الآن رسميًا Markdown ، والذي يمكنك تمكينه ضمن الإعدادات> مناقشة إذا كنت تستخدم المكون الإضافي. أو يمكنك استخدام مكون إضافي مثل WP-Markdown والذي سيحول محتوى علامة التخفيض على المنشور الخاص بك إلى HTML ، والعودة إلى Markdown عندما تحتاج إلى تحريره.
• بالنسبة إلى Evernote ، تسمح بعض تطبيقات Markdown مثل المحرر عبر الإنترنت Markable أو محرر Mac Byword بالتصدير والنشر مباشرة إلى الملاحظات. أو إذا كنت تفضل استخدام تطبيق Evernote على الويب مباشرةً ، فيمكنك استخدام ملحق متصفح يسمى Markdown Here والذي يحول ملاحظة محددة مكتوبة في Markdown إلى نص منسق بنقرة زر شريط الأدوات.
• لا يدعم مُحرر مستندات Google Markdown أصلاً حتى الآن ، ولكن بعض المحررين (مثل StackEdit) سيقومون بالتصدير / المزامنة مباشرةً مع Drive.

السلبيات

بالطبع ، مع البساطة الكبيرة تأتي القيود. كما أوضحت بالفعل ، لم تتم كتابة Markdown لمهام معالجة النصوص المعقدة التي تتطلب ميزات تنسيق متقدمة. إذا كان هذا هو ما تحتاجه ، فإن Markdown ليس الأداة الصحيحة.

ولكن بالنسبة للمطورين الذين يحتاجون إلى كتابة دليل مستخدم أو وثائق فنية أو تقرير تقني ، فإن Markdown يوفر توازنًا شبه مثالي بين البساطة والميزات التي تحتاجها.

ربما يكون أكبر عيب - خاصة بالنسبة لنا المهندسين المدمنين على التحكم في التغيير - هو عدم القدرة على العمل بشكل تعاوني في Markdown وتتبع التغييرات (على الرغم من ذلك ، هناك استثناء واحد ملحوظ لهذا ، هو المكون الإضافي StackEdit لمحرر مستندات Google). وبالطبع ، بأقل قدر من الجهد ، يمكن للمرء ببساطة التعاون في مستند Markdown عبر مستودع git ، وبالتالي الحصول على كل ما يحتاجه الفرد عادةً من تتبع للتغييرات والتعاون.

خاتمة

فهل تعلم Markdown للجميع؟ بالطبع لا. لا توجد أداة واحدة على الإطلاق.

ولكن إذا كنت مهندس برمجيات ، فقد تكون أداة الكتابة التي كنت تبحث عنها على وجه التحديد. لذا ، إذا لم تكن قد جربتها حتى الآن ، فعليك حقًا أن تأخذها في جولة.