تُستخدم "السلاجز" كمعرفات لكل من المقالات والفئات. يأتي "سلاج" المقالة من اسم الملف (بدون .md)، ويأتي "سلاج" الفئة من اسم الدليل.
القواعد
يجب أن يتطابق "سلاج" صالح مع التعبير العادي التالي:
/^[a-z0-9]+(?:-[a-z0-9]+)*$/
هذا يعني:
- أحرف صغيرة (
a-z) وأرقام (0-9) فقط - كلمات مفصولة بشرطات واحدة
- لا يمكن أن تبدأ أو تنتهي بشرطة
- لا توجد شرطات متتالية
- لا أحرف كبيرة، أو مسافات، أو أحرف خاصة
أمثلة
سلاجز صالحة
| سلاج | ملاحظات |
|---|---|
getting-started | كلمتان مفصولتان بشرطة |
billing | كلمة واحدة |
api-v2-reference | مقاطع متعددة |
setup123 | أحرف وأرقام |
سلاجز غير صالحة
| سلاج | السبب |
|---|---|
Getting-Started | أحرف كبيرة |
-leading-hyphen | تبدأ بشرطة |
trailing-hyphen- | تنتهي بشرطة |
double--hyphen | شرطات متتالية |
has spaces | تحتوي على مسافات |
special_chars! | تحتوي على علامات خاصة |
لماذا تهم السلاجز
تعمل السلاجز كمعرفات مستقرة وصديقة لعناوين URL. إنها تضمن:
- عناوين URL متسقة -- مسارات متوقعة في مركز المساعدة
- قابلية النقل -- آمنة للاستخدام كأسماء ملفات عبر أنظمة التشغيل
- التفرد -- داخل فئة، يجب أن يكون كل سلاج مقالة فريدًا