أدلة التنسيق والبرامج التعليمية
يجري تقديم الأدلة والبرامج التعليمية بلغة ترميز، مع تنسيق إضافي للمقدمة والرموز المختصرة.
مواقع المستندات
يؤخذ المحتوى الموجود على amp.dev من مستودعين، amp.dev و AMPHTML. ويتم أخذ جميع المستندات المرجعية تحت المكونات من AMPHTML إما من الوحدات المدمجة أو من الملحقات.
ثمة العديد من المستندات الأخرى التي يجري استيرادها إلى amp.dev منAMPHTML. وهي مدرجة في هذا الملف. لا تقم بتحديث هذه المستندات في مستودع amp.dev – سوف تتم الكتابة فوق تغييراتك في عمليات البناء التالية!
المقدمة
توجد المقدمة في أعلى كل دليل وبرنامج تعليمي.
مثال:
$title: Include Custom JavaScript in AMP Pages $order: 7 formats: - websites author: CrystalOnScript contributors: - fstanis description: For web experiences requiring a high amount of customization AMP has created amp-script, a component that allows the use of arbitrary JavaScript on your AMP page without affecting the page's overall performance.
$title | عنوان المستند الخاص بك كما يظهر في جدول المحتويات. اكتب الحرف الأول من الكلمة بحرف كبير، باستثناء “AMP” والأسماء الصحيحة الأخرى. واستخدم علامة الضم & بدلا من كلمة و. |
$order | حدد أين سيظهر جدول المحتويات للمستند الخاص بك. قد تحتاج إلى تحرير $order في المستندات الأخرى لكي يظهر في الموضع الصحيح. |
formats | اسرد خبرات AMP التي يتعلق بها المستند الخاص بك. إذا كان المستند يتعلق بمواقع ويب AMP وقصص AMP، ولكنه لا يتعلق بإعلانات AMP أو رسائل AMP الإلكترونية، فإن المقدمة ستكون كالتالي: `تنسيقاتyaml : - مواقع الويب - القصص ``</td> </tr> <tr> <td>
<code>author</code> </td> <td>أنت المؤلف! استخدم اسم مستخدم GitHub الخاص بك.</td> </tr> <tr> <td>
<code>contributors</code> </td> <td>اسرد أي شخص ساهم في كتابة مستندك. هذا الحقل اختياري.</td> </tr> <tr> <td>
<code>description</code> </td> <td>اكتب وصفًا مختصرًا للدليل أو البرنامج التعليمي. يساعد هذا الأمر في تحسين محرك البحث، ما يسهم في إيصال عملك إلى الأشخاص الذين يحتاجون إليه!</td> </tr> <tr> <td>
<code>tutorial</code> </td> <td>أضفtutorial: true` إلى مقدمة موقع الويب لإضافة رمز البرنامج التعليمي بجواره. توجد البرامج التعليمية في أسفل القسم الخاص به في جدول المحتويات. |
الرموز المختصرة
للاطلاع على قائمة بالرموز المختصرة واستخداماتها، يرجى عرض documentation.md على GitHub.
الصور
يتم دمج amp.dev مع AMP! بالتالي يجب أن تطابق الصور الخاصة بنا معايير amp-img. تستخدم عملية الإنشاء البنية التالية لتحويل الصور إلى تنسيق amp-img صحيح.
تصفية الأقسام
قد تكون بعض المستندات متعلقة بعدة تنسيقات AMP، ولكن قد تحتاج تنسيقات معينة إلى شرح أو معلومات إضافية لا تمت بصلة مع التنسيقات الأخرى. يمكنك تصفية هذه الأقسام من خلال طيها في الرمز المختصر التالي.
[filter formats="websites"] This is only visible for [websites](?format=websites). [/filter] [filter formats="websites"] This is only visible for [websites](?format=websites). [/filter] [filter formats="websites, email"] This is visible for [websites](?format=websites) & [email](?format=email). [/filter] [filter formats="stories"] This is visible for [stories](?format=stories). [/filter]
تلميحات
يمكنك إضافة تلميحات واستدعاءات من خلال طي النص في الرمز المختصر التالي:
[tip type="default"] Default tip [/tip] [tip type="important"] Important [/tip] [tip type="note"] Note [/tip] [tip type="read-on"] Read-on [/tip]
قصاصات الرموز البرمجية
ضع قصاصات الرموز البرمجية داخل مجموعات من ثلاث علامات اقتباس، وحدد اللغة في نهاية المجموعة الأولى من علامات الاقتباس.
```html
// code sample
wzxhzdk:1
wzxhzdk:2
تحذير: يتم إدراج الأمثلة المضمنة مباشرة في الصفحة. قد يؤدي ذلك إلى تعارضات إذا كانت المكونات مستعملة بالفعلة في الصفحة (على سبيل المثال `amp-consent`).
### معاينة الإطار العلوي
استخدم معاينة الإطار العلوي متى احتجت إلى تحدي عناصر الرأس أو تحديد أنماط عمومية داخل `
Hello AMP
``` [/example] Hello World
This is the cover page of this story.
First Page
This is the first page of this story.
-