2024-05-13
يبسط Markdown الكتابة والتعاون للكتّاب التقنيين، حيث يقدم صياغة بسيطة يسهل تعلمها واستخدامها. باستخدام Markdown، يمكنك إنشاء مستندات واضحة ومرنة ومتوافقة عالميًا دون التورط في تنسيق معقد. تغطي هذه الدليل أساسيات أفضل ممارسات Markdown، بدءًا من أساسيات صياغته وصولًا إلى نصائح لهيكلة المستندات وتحسين الإنتاجية. إليك نظرة عامة موجزة:
لماذا Markdown؟ سهل التعلم، تنسيق واضح، يعمل في كل مكان، مرن، وذو قبول واسع.
ما هو Markdown؟ طريقة بسيطة لتنسيق النص على الويب، أنشأها جون غروبر وآرون سوارتز في عام 2004.
أساسيات صياغة Markdown: العناوين، تنسيق النص، القوائم، الروابط، الصور، وكتل الشفرة.
هيكلة مستندات Markdown: تنظيم المحتوى بعناوين واضحة، تنسيق الشفرة بشكل صحيح، واستخدام القوائم والجدول بشكل فعال.
تحسين إنتاجية Markdown: استخدم الأدوات، إضافات المحرر، اختصارات لوحة المفاتيح، وتوسيع النص من أجل الكفاءة.
تذكر أن المفتاح للكتابة التقنية الفعّالة باستخدام Markdown هو الحفاظ على مستنداتك بسيطة وواضحة ومنظمة جيدًا. من خلال التركيز على هذه المبادئ الأساسية، يمكنك تسريع عملية الكتابة الخاصة بك وخلق مستندات يسهل قراءتها ومشاركتها.
تم إنشاء Markdown في عام 2004 بواسطة جون غروبر وآرون سوارتز. أرادوا إنشاء وسيلة لتسهيل الكتابة عبر الويب. اعتقدوا أن الطرق الحالية، مثل HTML، كانت صعبة جدًا لمعظم الناس. لذلك، أنشأوا Markdown لتمكين الناس من الكتابة بأسلوب بسيط يمكن تحويله بسهولة إلى صفحات ويب.
الفكرة الرئيسية وراء Markdown هي الحفاظ على الأمور بسيطة. تستخدم رموز النص العادية مثل النجوم (*) والشرطات السفلية (_) لتنسيق نصك. هذا يعني أنك يمكن أن تركز أكثر على ما تكتبه وأقل على كيف يبدو. عندما تنتهي، يمكنك تحويل نصك إلى صفحة ويب مرتبة دون الكثير من المتاعب.
Markdown تدور حول تسهيل الكتابة ومشاركتها على الويب. ليست مخصصة حقًا للطباعة ولكن لوضع الأشياء على الإنترنت بتنسيق جيد.
الكثير من الأشخاص الذين يكتبون مستندات تقنية يحبون Markdown. إنه بسيط ويعمل بشكل جيد في الأمور مثل العناوين، القوائم، الشفرات، الروابط، والصور. يمكنك بسهولة تتبع التغييرات والتعاون مع الآخرين في مستنداتك.
بالنسبة للكتّاب التقنيين، يعني Markdown وقتًا أقل للقلق بشأن جعل الأمور تبدو صحيحة ووقتًا أكثر لكتابة محتوى جيد. بالإضافة إلى ذلك، يمكنك بسهولة تحويل مستنداتك إلى صيغ مختلفة مثل HTML أو PDF. هذا يجعل Markdown أداة مفيدة لكتابة أشياء مثل قوالب الكتابة التقنية، وثائق واجهات برمجة التطبيقات، وإنتاج مستندات تقنية أخرى.
Markdown يشبه الاختصار للكتابة على الويب. إنه أسهل بكثير من HTML أو XML لأنك لا تحتاج ليتذكر مجموعة من الأكواد. لجعل النص بارزًا، على سبيل المثال، يمكنك لفه في نجمتين مزدوجتين مثل **هذا** بدلاً من استخدام علامات HTML مثل <b>هذا</b>. هذا يجعل تعلم واستخدام Markdown أمرًا سهلاً.
يمكنك من خلال Markdown تنسيق كتاباتك بسرعة مع الحفاظ على تركيزك. لا تحتاج للتوقف عن تدفقك للتلاعب بالتنسيقات المعقدة؛ صنع القوائم أو إضافة روابط مباشرة للغاية. هذا يعني أنك يمكنك الكتابة أكثر، بشكل أسرع، وأقل عناء.
تعمل ملفات Markdown بشكل جيد مع أدوات مثل Git وGitHub، والتي تساعد الأشخاص على العمل معًا في المشاريع. نظرًا لأن Markdown هو نص عادي، من السهل على الفرق رؤية ما تغير ودمج أعمالهم دون الإضرار بالتنسيق. هذا يجعل العمل معًا أكثر سلاسة ويحافظ على مظهر المستند جيدًا.
واحدة من أروع الأشياء في Markdown هي أنه يمكنك تحويل ملفاتك إلى العديد من التنسيقات المختلفة، مثل HTML، PDF، أو مستندات Word. هذا رائع لأنه يمكنك الكتابة مرة واحدة ثم مشاركة عملك بالطريقة التي تناسبك، سواء كان ذلك عبر الإنترنت أو ورقيًا. إنه مثل أن تكون قادرًا على التحدث بعدة لغات دون الحاجة إلى تعلمها جميعًا.
Markdown هو وسيلة بسيطة لتنسيق النص تجعل من السهل قراءته وكتابته. يمكن أن يتغير بعد ذلك إلى HTML، وهو الكود المستخدم لإنشاء صفحات الويب.
لإنشاء عناوين في Markdown، تبدأ السطر برمز #. كلما زاد عدد رموز # المستخدمة، كانت العنوان أصغر.
Markdown Toolbox
العنوان 1
العنوان 2
العنوان 3
العنوان 4
العنوان 5
العنوان 6
لتنسيق النص في Markdown:
استخدم نجمتين (**) حول النص لجعله غامقًا.
استخدم نجمة واحدة (*) لجعل النص مائلًا.
استخدم شريحتين (~) لعمل ~ضرب نبرة~.
استخدم علامات التساوي (==) لت ==تسليط الضوء== على النص.
لإنشاء قائمة نقطية، ابدأ كل سطر بنجمة (*). لإنشاء قوائم مرقمة، استخدم رقمًا متبوعًا بنقطة (.).
* العنصر 1
* العنصر 2
* عنصر متداخل 1
* عنصر متداخل 2
- العنصر الأول
- العنصر الثاني
- العنصر الثالث 1. عنصر مائل 2. عنصر مائل
لإضافة رابط، ضحض النص الذي تريد ربطه في أقواس مربعة ([])، ثم ضع عنوان الويب في أقواس عادية (()).
[نص الرابط](https://www.example.com)
لإضافة صورة، ابدأ بعلامة تعجب (!)، ثم وصف الصورة في أقواس مربعة، ورابط الصورة في أقواس عادية.
لجزء صغير من الشفرة، استخدم علامات اقتباس عكسية (` ) حول الشفرة. لكتلة أكبر من الشفرة، استخدم ثلاث علامات اقتباس عكسية (```) في البداية وفي النهاية. يمكنك أيضًا إضافة لغة البرمجة بعد مجموعة أولية من علامات الاقتباس العكسية لجعلها تبدو أجمل.
هذا هو `شيفرة مدمجة`.هذه هي كتلة الشفرة متعددة الأسطر
```python
print("مرحبًا بالعالم!")
عند تجميع مستند Markdown، من المهم إنشاء ترتيب واضح مع العناوين والعناوين الفرعية. يساعد ذلك القراء سريعًا في العثور على ما يبحثون عنه.
التزم باستخدام مستويات العناوين بشكل صحيح - تجنب استخدام العديد من المستويات إذا لم يكن ذلك ضروريًا
قم بوضع المحتوى من مواضيع عامة إلى مواضيع أكثر تفصيلاً
قم بتقسيم النص إلى أقسام سهلة القراءة مع عناوين توضح ما بداخله
اترك سطرين فارغين بين الأقسام لتسهيل القراءة
يعمل تنسيق كتل الشفرة بشكل صحيح على جعل مستنداتك التقنية أسهل في التصفح.
استخدم كتل الشفرة المحددة مع أسماء اللغات لقطع الشفرة الطويلة
للأجزاء القصيرة من الشفرة في نصك، استخدم علامات الاقتباس العكسية
احتفظ بكتل الشفرة منفصلة عن النصوص الأخرى من خلال ترك أسطر فارغة قبل وبعدها
تأكد من محاذاة كتل الشفرة إلى اليسار؛ واحتفظ بالمسافة البادئة متسقة
لا تترك فراغات إضافية في نهاية الأسطر في كتل الشفرة
تعتبر القوائم والجدوال رائعة لجعل المعلومات واضحة في Markdown.
استخدم قوائم مرقمة للخطوات
استخدم نقاط رصاصية لمجموعة العناصر
قم بجمع عناصر القائمة تحت العناوين إذا كانت لديك أقسام مختلفة
حاول عدم استخدام جدوال طويلة جدًا
احتفظ بجدوالك مرتبة ومحاذية
من المهم استخدام الروابط والصور بشكل صحيح.
اجعل نص الرابط ذا معنى - تجنب عبارات مثل "اضغط هنا"
ارتبط بالصور التي تم تخزينها في مكان آخر
تأكد من أن الصور صديقة للويب قبل إضافتها
تحقق دائمًا من أن الروابط والصور تعمل
هناك بعض الأدوات الرائعة هناك لجعل العمل باستخدام Markdown أسهل. تساعدك في رؤية كيف سيبدو مستندك، تحويله إلى تنسيقات مختلفة، والمزيد. إليك بعض منها:
Typora - أداة بسيطة تتيح لك رؤية مستندك مباشرة أثناء الكتابة وتحويله بسهولة إلى تنسيقات أخرى.
Markdown Monster - أداة متقدمة أكثر لمستخدمي Windows تساعدك على التحقق من كود Markdown الخاص بك وتخصيص كيف يبدو.
Pandoc - أداة يمكنك استخدامها من خلال سطر الأوامر لتحويل ملفات Markdown الخاصة بك إلى أنواع أخرى مثل HTML أو PDF.
تساعدك هذه الأدوات في العمل بشكل أسرع من خلال العناية بالتنسيقات لك والسماح لك برؤية تغييراتك على الفور.
يمكن أن تمنحك إضافة إضافات إلى محرر الشفرات الخاص بك المزيد من قوة Markdown:
Markdown All in One (VS Code) - يمنحك اختصارات، يساعدك في صنع جدول محتويات، ويسمح لك برؤية مستندك بشكل مباشر.
Markdown Preview Enhanced (Atom) - يسمح لك برؤية معاينة HTML مباشرة بجوار Markdown الخاص بك.
Markdownlint (VS Code) - يتحقق من كود Markdown الخاص بك بحثًا عن أخطاء ويعرض لك مكان وجودها.
تساعدك الإضافات في العمل بشكل أذكى من خلال القيام ببعض العمل لك والتقاط الأخطاء مبكرًا.
يمكن أن تساعدك معرفة هذه الاختصارات في تنسيق مستنداتك بشكل أسرع دون الحاجة إلى استخدام ماوسك:
غامق: Ctrl/⌘ + B
مائل: Ctrl/⌘ + I
رابط: Ctrl/⌘ + K
كتلة الشفرة: Ctrl/⌘ + Shift + C
حاول استخدام هذه الاختصارات كلما استطعت لتسريع عملك.
تسمح لك أدوات توسيع النص بكتابة كود قصير وتحويله تلقائيًا إلى شيء أطول. على سبيل المثال:
mdh1 → # العنوان 1
mdbold → **نص غامق**
قم بإعداد اختصاراتك الخاصة لإدراج صيغة Markdown بسرعة. بعض الأدوات الشائعة لذلك هي aText وTextExpander.
Markdown مفيد جدًا للأشخاص الذين يكتبون أشياء تقنية لأنه يساعدك في الكتابة والتعاون مع الآخرين بسهولة أكبر. إليك ما يجب أن تتذكره:
اجعلها بسيطة
يتعلق Markdown بتسهيل الأمور. ركز على ما تكتبه، ليس على مدى براقة مظهرها. اجعل مستنداتك مباشرة وسهلة القراءة.
هيكل المحتوى بوضوح
استخدم ميزات Markdown مثل العناوين، القوائم، والجدوال لتنظيم معلوماتك بشكل جيد. قم بتقسيم الأشياء إلى أقسام وتأكد من سلاسة كل شيء.
قم بتنسيق الشفرة بشكل صحيح
عند عرض الشفرة، فإن جعلها سهلة القراءة هو المفتاح. استخدم الكتل الصحيحة، واحتفظ بالتباعد متناسقًا، واحتفظ بها منفصلة عن النصوص الأخرى.
تحقق من الروابط والصور
الروابط القابلة للفهم والصور التي تظهر بشكل صحيح تجعل مستندك أفضل. تحقق دائمًا مرتين من أن الروابط والصور تعمل بشكل صحيح.
استخدم أدوات الإنتاجية
الأدوات التي تسمح لك برؤية التغييرات مباشرة، والإضافات، والاختصارات، والإضافات السريعة للنص يمكن أن توفر لك الوقت. ابحث عن الأدوات التي تجعل عملك أسهل.
تعاون بسلاسة
إن Markdown رائع للعمل معًا لأنه من السهل رؤية التغييرات ودمج العمل. استخدم نقاط قوته مع أدوات مثل Git لتحسين العمل مع الآخرين.
من خلال الالتزام بهذه النصائح، يمكن للكتّاب التقنيين توفير الوقت والعمل معًا بشكل جيد، وإنشاء مستندات Markdown عالية الجودة. أسلوب Markdown السهل والعملي يساعد في تحسين الكتابة التقنية.
إليك بعض الموارد السهلة الاتباع إذا كنت ترغب في التعمق أكثر في استخدام Markdown للكتابة التقنية:
دليل Markdown - دليل شامل يغطي كل ما تحتاج إلى معرفته عن Markdown.
الصياغة الأساسية | دليل Markdown - نصائح سريعة عن صياغة Markdown وكيفية تنسيق نصك.
دروس Markdown - طريقة تفاعلية خطوة بخطوة لتعلم Markdown.
إتقان Markdown · أدلة GitHub - تعلم كيفية استخدام Markdown مع GitHub من خلال أمثلة.
كيفية استخدام Markdown للكتابة التقنية | من إسرائيل أويتونجي | مستوى الترميز - نصائح لاستخدام Markdown خصيصًا للكتابة التقنية.
Typora - محرر بسيط حيث يمكنك رؤية تغييرات Markdown الخاصة بك مباشرة.
Markdown Monster - محرر Markdown غني بالميزات لمستخدمي Windows.
MacDown - محرر مجاني لـ macOS رائع لـ Markdown.
إضافات Markdown لـ VSCode - أدوات مفيدة لكتابة Markdown في Visual Studio Code.
Pandoc - أداة تسمح لك بتحويل مستندات Markdown الخاصة بك إلى تنسيقات مختلفة.
قوالب Markdown للكتابة التقنية - قوالب Markdown جاهزة للاستخدام للوثائق التقنية من Microsoft.
قوالب Markdown بواسطة Toptal - مجموعة من قوالب Markdown لكتابة الوثائق التقنية المختلفة.
يجب أن تجعل هذه الموارد استخدام Markdown في كتابتك التقنية أسهل. إذا كانت لديك المزيد من الأسئلة، فلا تتردد في طرحها!
نعم، يختار العديد من الكتاب التقنيين استخدام Markdown. لأن Markdown سهل الاستخدام، حيث يركز أكثر على ما تكتبه بدلاً من كيف يبدو. يمكنك تحويل Markdown إلى HTML وصيغ أخرى، مما يجعله رائعًا لكل من الوثائق التقنية عبر الإنترنت والمطبوعة. كثيرًا ما تستخدم الفرق Markdown على منصات مثل GitHub للعمل معًا. ببساطة، أسلوب Markdown المباشر يلائم احتياجات الكتابة التقنية بشكل جيد.
أفضل ثلاث نصائح للكتّاب التقنيين هي:
افهم من تكتب له و تأكد من أن كتابتك سهلة الفهم بالنسبة لهم
نظم مستنداتك جيدًا، باستخدام عناوين وأقسام واضحة
كن على دراية بموضوعك جيدًا حتى يمكنك توضيح الأمور بوضوح
تساعد هذه النصائح الكتاب التقنيين في صناعة أدلة يسهل متابعتها وتساعد الناس في استخدام المنتجات بشكل صحيح.
عند الكتابة باستخدام Markdown، حاول أن:
تحافظ على استخدامك للعناوين بشكل موحد
استخدم أسطر فارغة لفصل الفقرات والأقسام
اعرض أمثلة الشفرة في كتل
استخدم الغامق والمائل لتسليط الضوء على النقاط المهمة، لكن ليس بشكل مفرط
اجعل القوائم سهلة القراءة
تأكد من أن جميع الروابط والصور تعمل
كن حذرًا عند إنشاء الجداول للحفاظ عليها سهلة القراءة
إن تطبيق هذه النصائح يمكن أن يجعل مستندات Markdown الخاصة بك أكثر وضوحًا وفائدة.
نعم، يعتبر Markdown رائعًا لإنشاء الوثائق. يسمح للكتّاب بالتركيز على المحتوى الفعلي في صيغة بسيطة. يمكنك بسهولة مشاركة ملفات Markdown، أو تحويلها إلى HTML، PDF، وغير ذلك. إنها شائعة بشكل خاص للوثائق التقنية لأنها تعمل بشكل جيد مع أدوات التعاون مثل GitHub. مع العملية الجيدة، يمكن أن يساعد Markdown في إنشاء وثائق واضحة ومفيدة.