Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Change Log

## Unreleased

* 🐛 Honor empty `rules` and `rules2` lists in custom presets by disabling every rule in the specified chain.

## 4.3.0 - 2026-11-10

This release fixes two quadratic-time parsing paths that let crafted input stall rendering for minutes (security),
Expand Down
4 changes: 4 additions & 0 deletions docs/using.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ from markdown_it.presets import zero
zero.make()
```

In a custom preset's `components`, an empty `rules` list disables all rules in that component.
The same applies to `rules2` for inline post-processing rules.
Omitting either list leaves the corresponding rules unchanged.

```{jupyter-execute}
md = MarkdownIt("zero")
md.options
Expand Down
4 changes: 2 additions & 2 deletions markdown_it/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,10 @@ def configure(
if "components" in config:
for name, component in config["components"].items():
rules = component.get("rules", None)
if rules:
if rules is not None:
self[name].ruler.enableOnly(rules)
rules2 = component.get("rules2", None)
if rules2:
if rules2 is not None:
self[name].ruler2.enableOnly(rules2)

return self
Expand Down
30 changes: 29 additions & 1 deletion tests/test_api/test_main.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import pytest

from markdown_it import MarkdownIt
from markdown_it import MarkdownIt, presets
from markdown_it.token import Token

if TYPE_CHECKING:
Expand Down Expand Up @@ -107,6 +107,34 @@ def test_override_options():
assert md.options["maxNesting"] == 99


def test_preset_empty_rules() -> None:
"""An empty preset rule list disables the entire specified chain."""
for component, key, chain in (
("core", "rules", "core"),
("block", "rules", "block"),
("inline", "rules", "inline"),
("inline", "rules2", "inline2"),
):
config = presets.commonmark.make()
config["components"][component][key] = []

md = MarkdownIt(config)

assert md.get_active_rules()[chain] == []


def test_preset_empty_inline_rules_render_literal_text() -> None:
"""Custom presets can disable all inline markup without individual names."""
config = presets.commonmark.make()
config["components"]["inline"]["rules"] = []

md = MarkdownIt(config)

assert md.renderInline("**bold** [link](https://example.com)") == (
"**bold** [link](https://example.com)"
)


def test_gfm_like2_tasklists_editable():
md_default = MarkdownIt("gfm-like2", GFM_LIKE2_OPTIONS)
assert md_default.options["tasklists_editable"] is False
Expand Down