Skip to content

chore: make slugify dependency optional #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frostming merged 1 commit into from
Aug 8, 2025
Merged

chore: make slugify dependency optional #236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions marko/ext/toc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,16 @@

import re

from slugify import slugify

from marko.helpers import MarkoExtension, render_dispatch # type: ignore
from marko.html_renderer import HTMLRenderer

try:
from slugify import slugify
except ImportError:

def slugify(source: str) -> str: # type: ignore[misc]
return re.sub(r"[^\w\- ]+", "", source).strip().lower().replace(" ", "-")


class TocRendererMixin:
opening = "<ul>"
Expand Down Expand Up @@ -71,7 +76,8 @@ def render_toc(self, maxdepth=3):
@render_dispatch(HTMLRenderer)
def render_heading(self, element):
children = self.render_children(element)
slug = slugify(re.sub(r"<.+?>", "", children))
raw = re.sub(r"<.+?>", "", children)
slug = slugify(raw)
self.headings.append((int(element.level), slug, children))
return '<h{0} id="{1}">{2}</h{0}>\n'.format(element.level, slug, children)

Expand Down
Loading