تخط المحتوى

التوثيق


مقدمة

أهلاً بك في الشبح! يوفّر دليل المرجع السريع هذا أمثلة على الكتابة في Markdown، وهو تنسيق ترميز نصوص بسيطة أنشأه John Gruber. لمزيد من المعلومات، نرجو زيارة موقع John Gruber على http://www.daringfireball.net.

يملك الشبح دعمًا مدمجًا لمعالج cmark-gfm. لكن، يمكنه أيضًا الكشف الآلي لمعالجات Pandoc، أو MultiMarkdown، أو cmark. ببساطة، ركّب أيًا من هذه المعالجات وتأكد من إضافة مواقع تركيبها إلى متغير بيئة PATH لنظامك. سيكتشف الشبح تركيبها آليًا عند بدء التشغيل، ويعطيك معاينة HTML حيّة وخيارات تصدير تبعًا لذلك.

العناوين

# Level 1 Heading
## Level 2 Heading ##
###### Level 6 Heading

Level 1 Heading
===============
some text

Level 2 Heading
---------------
some more text

الفقرات

This is a paragraph.
This is another line in the same paragraph using a manual line break.

This is a new paragraph.

تنسيق سطري

يمكنك عمل مائل أو حتى غليظ بطريقتين. الأولى عبر إحاطة النص بنجوم (*)، بينما الثانية عبر الشّرطات السفلية (_).

This is *italics* with asterisks.
This is _italics_ with underscores.

This is **bold** with asterisks.
This is __bold__ with underscores.

يمكنك أيضًا عمل مائل غليظ عبر المزج والمطابقة، كالتالي:

This is ***bold italics*** with asterisks.
This is **_bold italics_** mixing.
This is another *__bold italics__*.
etc.

الروابط

يمكنك الرّبط إلى مواقع مختلفة:

Click [here](http://url.com "Title") to visit a website.

يمكنك أيضًا استعمال روابط مرجعية:

[This][id] is a reference link which is defined below.

[id]: http://url.com "Title"

الصور

يمكنك تضمين الصور كالتالي:

![alternate text](./image.jpg "Title")

يمكنك أيضًا استعمال نفس البنية كما في الرّوابط المرجعية:

![alternate text][id] for a reference defined below.

[id]: ./image.jpg "Title"

القوائم

يمكنك استعمال قوائم مرتبة:

1. Item one.
2. Item two.
3. Item three.

أو يمكنك استعمال قوائم غير مرتبة:

* Item one.
+ Item two.
- Item three.

يمكنك المزج والمطابقة مع قوائم متداخلة:

1. Item one.
    * Subitem one.
    * Subitem two.
2. Item two.
    - Subitem one.
    - Subitem two.
3. Item three.
    1. Subitem three.

مقطع الشيفرة

يمكنك الإزاحة بأربع مسافات أو أكثر أو حرف جدولة لإنشاء مقطع شيفرة:

This is a normal paragraph, followed by a code block.
    
    for (int i = 0; i < 10; i++) {
        System.out.println("i = " + i);
    }
    
The above will be displayed as a preformatted block of code.

في بعض محوّلات Markdown، مثل Pandoc أو GitHub، يمكنك استعمال علامات الاقتباس الخلفية في GitHub-Flavored Markdown لتحديد مقاطع الشيفرة بدلاً من إزاحة المقطع، كالتالي:

```
for (int i = 0; i < 10; i++) {
    System.out.println("i = " + i);
}
```

سيعرض ما سبق كذلك كمقطع شيفرة منسق مبدئيًا.

امتدادات الشيفرة

يمكنك استخدام علامات الترجيع في منتصف الفقرة لتحديد الكود، كما هو الحال مع علامة `<html>`. يمكنك استخدام علامات الترجيع الحرفية باستخدام أكثر من علامة ترجيع واحدة، كما في هذا المثال: `` `علامة ترجيع مهرب` ``.

اقتباسات المقاطع

يمكنك استعمال أقواس زاوية بأسلوب البريد الإلكتروني لتحديد اقتباسات المقاطع، كالتالي:

> This is a block quote.
>
>> This is a nested block quote.

قواعد أفقية

استعمل ثلاث شرطات أو أكثر (-)، أو شَرطات سفلية (_)، أو نجوم (*) للقواعد الأفقية، كالتالي:

---

***
___

يمكنك حتى وضع مسافات بين كل حرف:

- - -

امتدادات Markdown

تضيف بعض معالجات Markdown بناءً للجداول، والحواشي السفلية، وغير ذلك لتوسيع مواصفات John Gruber Markdown الأصلية. أدناه مثال استعمال حاشية سفلية لـ Pandoc، وMultiMarkdown، ومعالجات أخرى تدعم الامتداد:

Here is the body text that has a footnote.[^footnoteid]

[^footnoteid]:  Here is the footnote text.

أدناه جدول Pandoc عينة:

Column One     Column Two
----------     ----------
Row Text 1     Row Text 2
Row Text 1     Row Text 2

Table:  Pandoc sample table.

أدناه جدول cmark-gfm أو MultiMarkdown عينة:

Column One | Column Two
---------- | ----------
Row Text 1 | Row Text 2
Row Text 1 | Row Text 2

هناك المزيد من بناءات الجداول التي يمكن أن تدعمها معالجات Markdown هذه. هناك أيضًا العديد من الامتدادات. لمزيد من المعلومات حول هذه المعالجات، نرجو زيارة المواقع التالية:

يمكن العثور على مواصفات John Gruber Markdown الأصلية على http://daringfireball.net/projects/markdown/.

الاختصارات

يدعم الشبح الاختصارات التالية لتحرير Markdown:

Ctrl+B
يطبّق التنسيق الغليظ (القوي).
Ctrl+I
يطبّق التنسيق المائل (التركيز).
Ctrl+K
يطبّق تنسيق الشطب.
Ctrl+/
يدرج تعليق HTML في موضع المؤشر إذا لم يحدد نص، أو سيحوّل النص المحدد إلى تعليق HTML.
Tab
يزيح أسطر النص المحددة.
Shift+Tab
يزيل إزاحة أسطر النص المحددة.
Shift+Enter
يدرج فاصل سطر بأسلوب Markdown.
Ctrl+Enter
يدرج فاصل سطر كالمعتاد، ما عدا الإزاحة الحالية لن تراعى. بعبارة أخرى، إذا كنت تكتب على سطر مُزاح وضغطت Ctrl+Enter، فلن تضاف إزاحة إلى السطر الجديد. لاحظ أن معدّل Ctrl يمكن دمجه مع معدّل Shift لإنتاج سطر غير مُزاح وفاصل سطر بأسلوب Markdown.
Ctrl+.
يحوّل السطر الحالي أو الأسطر المحددة إلى اقتباس مقطع.
Ctrl+,
يزيل أي تنسيق اقتباس مقطع من السطر الحالي أو أسطر النص المحددة.
Ctrl+8
يحوّل السطر الحالي أو الأسطر المحددة إلى قائمة نقطية بعلامة *. على سبيل المثال، إذا حددت نصًا ضمن الأسطر التالية:
  List item one.
  List item two.

سيحوّل الضغط على مفتاح الاختصار هذا الأسطر المحددة إلى قائمة نقطية كالتالي:

  * List item one.
  * List item two.
Ctrl+Shift+-
يحوّل السطر الحالي أو الأسطر المحددة إلى قائمة نقطية بعلامة -. على سبيل المثال، إذا حددت نصًا ضمن الأسطر التالية:
  List item one.
  List item two.

سيحوّل الضغط على مفتاح الاختصار هذا الأسطر المحددة إلى قائمة نقطية كالتالي:

  - List item one.
  - List item two.
Ctrl+Shift+=
يؤدي الضغط على Ctrl وShift مع حرف = إلى تحويل السطر الحالي أو الأسطر المحددة إلى قائمة نقطية بعلامة +. على سبيل المثال، إذا حددت نصًا ضمن الأسطر التالية:
  List item one.
  List item two.

سيحوّل الضغط على مفتاح الاختصار هذا الأسطر المحددة إلى قائمة نقطية كالتالي:

  + List item one.
  + List item two.
Ctrl+1
يحوّل السطر الحالي أو الأسطر المحددة إلى قائمة مرقمة بعلامة .. على سبيل المثال، إذا حددت نصًا ضمن الأسطر التالية:
  List item one.
  List item two.

سيحوّل الضغط على مفتاح الاختصار هذا الأسطر المحددة إلى قائمة مرقمة كالتالي:

  1. List item one.
  2. List item two.
Ctrl+0
يحوّل السطر الحالي أو الأسطر المحددة إلى قائمة مرقمة بعلامة ). على سبيل المثال، إذا حددت نصًا ضمن الأسطر التالية:
  List item one.
  List item two.

سيحوّل الضغط على مفتاح الاختصار هذا الأسطر المحددة إلى قائمة مرقمة كالتالي:

  1) List item one.
  2) List item two.
Ctrl+T
يحوّل السطر الحالي أو الأسطر المحددة إلى عنصر قائمة مهام GitHub-Flavored Markdown. على سبيل المثال، إذا حددت نصًا ضمن الأسطر التالية:
  Important thing to do.
  Another important thing to do.

سيحوّل الضغط على مفتاح الاختصار هذا الأسطر المحددة إلى قائمة مهام كالتالي:

  - [ ] Important thing to do.
  - [ ] Another important thing to do.
Ctrl+D
عندما يكون السطر الحالي من النص عنصر قائمة مهام GitHub-Flavored Markdown، سيؤدي الضغط على مفتاح الاختصار هذا إلى تبديل حالة إكمال المهمة، بوضع x في مربع الاختيار إذا اكتملت المهمة، أو إزالة x إذا كانت غير مكتملة. على سبيل المثال:
  - [ ] This is an incomplete task.
  - [x] This task as done!
الأحرف المتطابقة
عندما يحدد نص ضمن سطر واحد، سيؤدي الضغط على أي من الأحرف أعلاه إلى إحاطة النص المحدد بذلك الحرف وحرفه الإغلاقي المطابق. على سبيل المثال، إذا حددت الكلمة dog ثم أدخلت الحرف (، فستحاط الكلمة dog بين قوسين وتصبح (dog). أدناه جدول يظهر الحرف المطبوع والحرف الإغلاقي المطابق:

الافتتاحيالإغلاقي
""
''
()
[]
{}
**
__
``
<>

لتمكين المطابقة الآلية للأحرف أثناء الكتابة، اختر "طابق الأحرف آليًا أثناء الكتابة" من لسان المحرر في حوار التفضيلات، المتاح من شريط القائمة ضمن الخيار `إعدادات->تفضيلات...`. يمكنك كذلك تخصيص أي الأحرف مطابقة عبر اختيار زر "خصّص الأحرف المطابقة...".
سحب وإفلات ملفات الصور
بديل لاختيار الخيار تحرير->أدرج صورة... من شريط القائمة هو سحب وإفلات أي ملف صورة من نظام ملفاتك إلى نافذة المحرر. سيدرج التطبيق نص صورة سطريًا بمسار ملف صورتك النسبي إلى موقع المستند المفتوح حاليًا، أو المسار الكامل إذا كان المستند بلا عنوان. على سبيل المثال:

  ![](../../relative/path/to/your/file.png)

أو إذا كان المستند بلا عنوان:

  ![](file:///full/path/to/your/file.png)