انتقل إلى المحتوى الرئيسي

إنشاء ملفات Markdown مع كتل الشفرة البرمجية

تلميح

كتل الشفرة البرمجية المنسقة جيدًا في Markdown تجعل وثائقك أكثر قابلية للقراءة وأسهل في الصيانة.

كتل الشفرة الأساسية​

الشفرة المضمنة​

استخدم علامات الاقتباس المفردة للشفرة المضمنة:

  • كلمة واحدة: متغير
  • كلمات متعددة: معلمة الدالة
  • مع الرموز: npm install اسم-الحزمة

كتل الشفرة المحددة​

استخدم علامات الاقتباس الثلاثية للشفرة متعددة الأسطر:

هذه كتلة شفرة أساسية
بدون تمييز بناء الجملة

تمييز بناء الجملة الخاص باللغة​

أضف اسم اللغة بعد علامات الاقتباس الافتتاحية:

const greeting = 'مرحبًا، عالم!';
console.log(greeting);
def greet(name):
    print(f"مرحبًا، {name}!")

التنسيق المتقدم​

أرقام الأسطر​

بعض معالجات Markdown تدعم أرقام الأسطر:

// هذا السطر مميز
const x = 1;
// هذه الأسطر مميزة
// وكذلك هذا السطر
const y = 2;

أشرطة العناوين​

أضف عناوين إلى كتل الشفرة الخاصة بك:

app.js
const express = require('express');
const app = express();

app.get('/', (req, res) => {
  res.send('مرحبًا، عالم!');
});

كتل الاختلافات​

عرض تغييرات الشفرة باستخدام بناء جملة diff:

- const oldCode = 'سيتم إزالته';
+ const newCode = 'سيتم إضافته';
  const unchanged = 'يبقى كما هو';

ميزات MDX​

كتل الشفرة التفاعلية​

// مثال JavaScript
function add(a, b) {
  return a + b;
}

أمثلة الشفرة المباشرة​

function Button() {
  return (
    <button onClick={() => alert('تم النقر!')}>
      انقر هنا
    </button>
  );
}

اللغات الشائعة​

تطوير الويب​

index.html
<!DOCTYPE html>
<html>
<head>
    <title>مثال</title>
</head>
<body>
    <h1>مرحبًا، عالم</h1>
</body>
</html>
styles.css
body {
    font-family: Arial, sans-serif;
    margin: 0;
    padding: 20px;
}
app.ts
interface User {
    name: string;
    age: number;
}

const user: User = {
    name: "John",
    age: 30
};

تطوير الخلفية​

Main.java
public class Main {
    public static void main(String[] args) {
        System.out.println("مرحبًا، عالم!");
    }
}
query.sql
SELECT users.name, orders.order_date
FROM users
JOIN orders ON users.id = orders.user_id
WHERE orders.status = 'مكتمل';

أفضل الممارسات​

1. التنسيق المتسق​

✅ افعل:

# العنوان

## القسم

\```javascript
// الشفرة هنا
\```

❌ لا تفعل:

#العنوان
##القسم
\```javascript
//الشفرة هنا
\```

2. تحديد اللغة بوضوح​

✅ افعل:

\```python
def example():
    pass
\```

❌ لا تفعل:

\```
def example():
    pass
\```

3. المسافة البادئة الصحيحة​

✅ افعل:

- عنصر القائمة
  \```javascript
  const x = 1;
  \```

❌ لا تفعل:

- عنصر القائمة
\```javascript
const x = 1;
\```

حالات خاصة​

أوامر Shell​

لتعليمات سطر الأوامر:

# الأمر مع الإخراج
$ npm install الحزمة
جاري تثبيت الحزمة...
تم!

متغيرات البيئة​

.env
API_KEY=your_api_key_here
DATABASE_URL=postgres://user:pass@localhost:5432/db

ملفات التكوين​

package.json
{
  "name": "project",
  "version": "1.0.0",
  "scripts": {
    "start": "node index.js"
  }
}

استكشاف الأخطاء وإصلاحها​

المشكلات الشائعة​

  1. علامات الاقتباس داخل كتل الشفرة

    \`\`\`
    استخدم \` للشفرة المضمنة
    \`\`\`

  2. فواصل الأسطر

    هذا يتطلب مسافتين  
    لإنشاء فاصل سطر

  3. أحرف الهروب

    \* ليس عنصر قائمة
    \` ليست شفرة مضمنة

التكامل مع المحرر​

اختصارات Cursor​

الإجراءالاختصار
كتلة الشفرةCtrl + Shift + K
الشفرة المضمنةCtrl + `
المعاينةCtrl + Shift + V

الإضافات​

إضافات Markdown الموصى بها:

  • Markdown All in One
  • markdownlint
  • Markdown Preview Enhanced
تلميح

استخدم ميزة معاينة Markdown في Cursor للتحقق من التنسيق في الوقت الفعلي!

الموارد ذات الصلة​