بطاقة منفردة
هذه بطاقة مستقلة مع أيقونة. البطاقات مفيدة لإبراز المعلومات أو الميزات الرئيسية.
يستخدم كل نوع من أنواع التنبيهات الجانبية بناء الجملة ::: مع عنوانه الافتراضي.
تحصل مكونات التنبيه الجانبي المدمجة في Starlight على زوايا مدوّرة وظل متعدد الطبقات:
.starlight-aside { border-radius: 0.75rem; box-shadow: 0 2px 4px rgba(0,0,0,0.04), 0 8px 16px rgba(0,0,0,0.08), 0 24px 48px rgba(0,0,0,0.12);}هذا هو محتوى تبويب النظرة العامة. يحتوي على نص عادي للتحقق من عرض التبويبات الأساسي.
هذا هو تبويب التفاصيل. يجب أن يكون التبديل بين التبويبات فورياً دون إعادة تحميل الصفحة.
محتوى فقرة عادية في التبويب الأول.
const greeting = "Hello from a code block inside a tab!";console.log(greeting);كود مضمّنتشترك مجموعتا التبويبات هاتان في syncKey="pkg". يجب أن يؤدي تحديد تبويب في إحدى المجموعتين إلى تحديث الأخرى.
أمر التثبيت:
npm install @f5-sales-demo/docs-themepnpm add @f5-sales-demo/docs-themeyarn add @f5-sales-demo/docs-themeأمر التشغيل:
npm run devpnpm devyarn devاستنساخ المستودع
git clone https://github.com/example/repo.gitcd repoتثبيت التبعيات
npm installتشغيل خادم التطوير
npm run devسيكون الموقع متاحاً على http://localhost:4321.
بطاقة منفردة
هذه بطاقة مستقلة مع أيقونة. البطاقات مفيدة لإبراز المعلومات أو الميزات الرئيسية.
الأداء
يُقدّم Astro صفحات خالية من JavaScript افتراضياً لتحميل أسرع للصفحات.
قابل للتخصيص
يوفر Starlight خيارات واسعة للسمات والإضافات.
سهل الوصول
تضمن ميزات إمكانية الوصول المدمجة وصول المحتوى إلى الجميع.
موثّق
التوثيق الشامل يجعل البدء أمراً سهلاً ومباشراً.
الخطوة الأولى
قم بتكوين إعدادات مشروعك ومتغيرات البيئة.
الخطوة الثانية
أنشئ صفحات المحتوى باستخدام تنسيق MDX.
الخطوة الثالثة
قم بالمعاينة محلياً باستخدام خادم التطوير.
الخطوة الرابعة
انشر على منصة الاستضافة التي تختارها.
توفر السمة مكوّن LinkCard الذي يعمل مع أيقونات أو بدونها. استورده من السمة:
import LinkCard from '@f5-sales-demo/docs-theme/components/LinkCard.astro';أضف خاصية icon باستخدام بناء الجملة prefix:name. جميع حزم الأيقونات الثماني مدعومة — راجع وثائق حزم الأيقونات للاطلاع على الكتالوج الكامل.
lucide:)carbon:)mdi:)phosphor:)tabler:)f5-brand:)f5xc:)هذه الأيقونات متعددة الألوان وتستخدم خصائص CSS المخصصة للتكيف مع ألوان الوضع الفاتح/الداكن.
hashicorp-flight:)جميع متغيرات الشارات الستة معروضة بشكل مضمّن:
افتراضي ملاحظة خطر نجاح تلميح تحذيركل حجم مع متغيّر:
تلميح صغير خطر متوسط نجاح كبيرتستخدم العناوين التالية بناء جملة إضافة starlight-heading-badges.
يحتوي هذا العنوان على شارة نجاح تشير إلى أن الميزة مستقرة.
يحتوي هذا العنوان على شارة تحذير تشير إلى أن الـ API تجريبي.
يحتوي هذا العنوان على شارة خطر تشير إلى الإهمال.
يحتوي هذا العنوان على شارة تلميح تشير إلى ميزة جديدة.
يحتوي هذا العنوان على شارة ملاحظة تشير إلى التحديثات الأخيرة.
يحتوي هذا العنوان على شارة افتراضية دون تحديد متغيّر.
تحقق من الشريط الجانبي: تحتوي هذه الصفحة على شارة “جديد” مع متغيّر tip مُطبّق عبر الـ frontmatter.
| الميزة | الحالة | الأولوية |
|---|---|---|
| الوضع الداكن | مدعوم | عالية |
| تكبير الصور | مدعوم | متوسطة |
| مخططات Mermaid | مدعوم | متوسطة |
| شارات العناوين | مدعوم | منخفضة |
| الخاصية | النوع | الافتراضي | الوصف |
|---|---|---|---|
title | string | — | عنوان الصفحة المعروض في الرأس |
description | string | "" | وصف ميتا لتحسين محركات البحث |
sidebar.order | number | 0 | ترتيب الفرز في الشريط الجانبي |
sidebar.badge | object | null | الشارة المعروضة بجانب تسمية الشريط الجانبي |
template | "doc" | "splash" | "doc" | قالب تخطيط الصفحة |
تختبر الصورة أدناه إضافة starlight-image-zoom. انقر للتكبير.
