Markdown دليل كتلة الشفرة: الشفرة داخل الخط، الكتلة المحصنة، وتسليط الضوء على النص

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

رمز داخل الخط

لف مقتطف قصير أو تعبير واحد في مقاطع خلفية واحدة:

Use `console.log()` to print output.
Set the variable with `const x = 42;`.
The file is saved as `README.md`.

الرمز داخل الخط يقدم في خط واحد، مميز بصرياً عن النص المحيط. استخدمه في:

• أسماء الوظائف والأساليب: addEventListener()
• أسماء المتغيرات: isLoading
• أسماء الملفات: package.json
• حجج القيادة: --verbose
• تعبيرات رمز قصيرة

إذا كان رمزك في الخط يحتوي على علامة خلفية، استخدم علامات خلفية مزدوجة لتغليفها:

`` `backtick inside` ``

كتلة شفرة محصورة

للشفرة متعددة السطر، استخدم العلامات الظهرية الثلاثية (`) لفتح وإغلاق الكتلة:

```
This is a code block.
It preserves all whitespace and line breaks.
No formatting is applied inside.
```

التخفيضات، المسافات، والخطوط الجديدة كلها محفوظة تماماً.

إبرز النحو

إضافة معرف لغة بعد فتح الاختصاصات الثلاثية لتمكين تسليط الضوء على النحو:

```python
def greet(name: str) -> str:
    return f"Hello, {name}!"

print(greet("World"))
```

```javascript
const greet = (name) => `Hello, ${name}!`;
console.log(greet("World"));
```

```bash
#!/bin/bash
echo "Hello, World!"
ls -la ~/Documents
```

معرفات اللغة المشتركة

كتلة الرموز المضغوطة

يستخدم نحو Markdown الأقدم إدراج 4 فراغات لكتل الرمز:

    function oldStyle() {
        return "This is a code block";
    }

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

تحويل الكود من Word المستندات

نص الفضاء الواحد في Word (Courier New، Consolas، إلخ) يتحول إلى رمز داخل الخط عند استخدام WordToMD. Multi-line code in Word converts depending on how it was formatted:

• الفقرة النصية الفضاء الواحد → يمكن أن تصبح مقطوعات شفرة متعددة
• Word كود النمط → تحويل إلى كتلة شفرة
• كتلة نصية حرفية قد يحتاج إلى التسديد اليدوي

بعد التحويل، تحقق من أقسام الرمز وإضافة السياج المناسب إذا لزم الأمر:

1. العثور على الرمز الذي يجب أن يكون كتلة
2. لفيها بثلاثة أدوات
3. إضافة معرف اللغة المناسب

أمثلة خاصة باللغة

طلبات HTTP

```http
POST /api/users HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer TOKEN

{
  "name": "Alice",
  "email": "alice@example.com"
}
```

أوامر المحطة

```bash
npm install
npm run build
npm run dev
```

إنتاج الفرق

```diff
- const oldValue = "hello";
+ const newValue = "world";
  console.log(newValue);
```

تكوين YAML

```yaml
server:
  host: localhost
  port: 8080
  debug: true
database:
  url: postgresql://localhost:5432/mydb
```

كتلة الكود المضمنة (للتوثيق)

عند توثيق Markdown نفسها، استخدم 4 بيكتيك لتغليف كتلة تحتوي على 3 بيكتيك:

````markdown
```python
# This is a code block inside documentation
```
````

دعم المنصة

أرقام الخطوط

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

• Prism.js (يستخدم من قبل العديد من المجموعات المشتركة) add {numberLines: true} في حائط الرمز
• GitHub لا توجد أرقام خطوط محلية في Markdown (استخدم GitHub عرض اللوم بدلاً من ذلك)
• GitBook أرقام السطر عبر إعدادات كتلة الرمز

نسخ الشفرة من الكتل

GitHub والعديد من المنصات تضيف زر Copy إلى كتلة الشفرة تلقائيًا. هذا هو تعزيز التصوير لا يتطلب أي شيء خاص في Markdown الخاص بك.

FAQ

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

كيف أظهر الخلفيات داخل كتلة شفرة؟ داخل كتلة شفرة مغلقة، يتم التعامل مع الخلفيات كحروف حرفية. فقط السياج ذو الثلاثة أدوار يحتاج إلى معالجة خاصة

وثيقتي Word كانت تحتوي على كود ملون ملحوظ بالهجرة هل سوف WordToMD الحفاظ على الألوان؟ لا Markdown الكود لا يحافظ على تنسيق الألوان. WordToMD يحول النص إلى كتلة رمزية يتم بعد ذلك تطبيق تسليط الضوء على النصوص بواسطة Markdown على أساس معرف اللغة.

هل يمكنني تسليط الضوء على خطوط محددة داخل كتلة رمزية؟ النموذج Markdown لا يدعم هذا. بعض المنصات (مثل Astro مع Shiki ، أو Hugo) دعم الخط الذي يسلط الضوء عبر التعليقات: {1,3-5} بعد معرف اللغة.

أدلة ذات صلة

• Markdown النحو ورقة مرجعية سريعة الإشارة الكاملة
• Word إلى API الوثائق الوثائق التي تتطلب الكثير من الرموز
• Word إلى GitHub Markdown GitHub تنسيق رمز محدد

النتيجة

كتلة الرموز المحددة هي بسيطة: backticks للشفرة داخل الخط، و backticks ثلاثية مع معرف لغة للكتل. بعد تحويل مستند Word مع WordToMD، التحقق من أن نص الفضاء الواحد قد تم تغليفه بشكل صحيح في تركيبة الكود، وإضافة معرفات اللغة لإبرز النطق الصحيح على منصة الهدف.