slugify

​

Overview

​

Syntax

{{ slugify(text) }}

​

Parameters

​

Return Value

• Converted to lowercase
• HTML tags stripped
• Spaces replaced with hyphens
• Special characters removed (only alphanumeric, hyphens, and underscores remain)
• Multiple consecutive hyphens collapsed to single hyphen
• Leading and trailing hyphens removed

​

Usage

​

Import the Macro

{% from 'path/to/slugify.html' import slugify %}

​

Basic Example

{{ slugify('Give me slug') }}

​

With Special Characters

{{ slugify('Hello World! @#$ How are you?') }}

​

With HTML Tags

{{ slugify('<h1>Title with Tags</h1>') }}

​

Common Use Cases

{# Create anchor ID from heading #}
<h2 id="{{ slugify(heading_text) }}">{{ heading_text }}</h2>

{# Generate URL-friendly filenames #}
{% set filename = slugify(page.name) ~ '.html' %}

{# Create CSS class names #}
<div class="section-{{ slugify(section.title) }}"></div>

​

Implementation Details

1. Converts to string and lowercase
2. Strips HTML tags
3. Replaces whitespace characters (tabs, newlines, spaces) with hyphens
4. Removes all non-alphanumeric characters except hyphens and underscores
5. Collapses multiple consecutive hyphens into a single hyphen
6. Trims hyphens from the beginning and end of the string