Slugs are strings that can be used in URLs. Slugs must fulfill all of the following rules:

  • Slugs must be at least one character and at most 64 characters long.

  • Slugs may only contain letters, numbers, dots ("."), dashes ("-") and underscores ("_").

  • All letters must be in lower case and from the basic latin alphabet.


Good examples:

  • my-mod

  • version-1.3.4

  • test-6.4.1_RC-3

Bad examples:

  • be$t-mod(dollar signs are not allowed)

  • café-mod("é" is not a letter of the latin alphabet)

  • <script>alert('xss')</script> ("<>()'/" are not allowed)

  • my mod 2 (whitespaces are not allowed)

  • a-very-very-very-very-very-very-very-very-very-very-very-very-very-long-name (longer than 64 characters)

Last updated