Slakconventies
1 min leestijd
Slakken worden gebruikt als identificatiemiddelen voor zowel artikelen als categorieën. Een artikel-slug komt van de bestandsnaam (minus .md), en een categorie-slug komt van de mapnaam.
Regels
Een geldige slug moet voldoen aan de volgende regex:
/^[a-z0-9]+(?:-[a-z0-9]+)*$/
Dit betekent:
- Alleen kleine letters (
a-z) en cijfers (0-9) - Woorden gescheiden door enkele koppeltekens
- Kan niet beginnen of eindigen met een koppelteken
- Geen opeenvolgende koppeltekens
- Geen hoofdletters, spaties of speciale tekens
Voorbeelden
Geldige slakken
| Slug | Opmerkingen |
|---|---|
getting-started | Twee woorden, gescheiden door een koppelteken |
billing | Enkel woord |
api-v2-reference | Meerdere segmenten |
setup123 | Letters en cijfers |
Ongeldige slakken
| Slug | Reden |
|---|---|
Getting-Started | Hoofdletters |
-leading-hyphen | Begint met een koppelteken |
trailing-hyphen- | Eindigt met een koppelteken |
double--hyphen | Opeenvolgende koppeltekens |
has spaces | Bevat spaties |
special_chars! | Onderstrepingstekens en speciale tekens |
Waarom Slakken Belangrijk Zijn
Slakken dienen als URL-vriendelijke, stabiele identificatiemiddelen. Ze zorgen voor:
- Consistente URL's -- voorspelbare paden in het helpcentrum
- Overdraagbaarheid -- veilig te gebruiken als bestandsnamen op verschillende besturingssystemen
- Uniciteit -- binnen een categorie moet elke artikel-slug uniek zijn