Skip to content

Add markdown heading anchor(TS-2595) #1177

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

Open
Roffenlund wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Add markdown heading anchor(TS-2595) #1177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c7c5cb4
Add MarkdownIt plugins
Roffenlund Aug 27, 2025
5c5167c
Use anchors_plugin with MarkdownIt
Roffenlund Aug 27, 2025
ec17152
Update markdown test
Roffenlund Aug 27, 2025
5eb9304
Prepend user-content to IDs for anchors
x753 Sep 1, 2025
949c8ac
Add javascript for anchor navigation
x753 Sep 1, 2025
33cf940
Update markdown tests
x753 Sep 1, 2025
36cfbaf
Add _ to javascript regex for anchor slugs
x753 Sep 1, 2025
9175d98
Improve anchor navigation
x753 Sep 1, 2025
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
22 changes: 21 additions & 1 deletion django/poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions django/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ django-cors-headers = "^3.7.0"
boto3 = "^1.17.47"
bleach = "^3.3.0"
markdown-it-py = {version = "2.1.0", extras = ["linkify"]}
mdit-py-plugins = "0.4.2"
abyss = {git = "https://github.com/akx/abyss.git", rev = "4352e557f25a303f718ec1bf82ea0ca545ebc077"}
lxml = "^4.9.1"
pygments = "^2.16.1"
Expand Down
4 changes: 2 additions & 2 deletions django/thunderstore/api/cyberstorm/tests/test_markdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ def test_readme_api_view__prerenders_markup(api_client: APIClient) -> None:
f"/api/cyberstorm/package/{v.package.namespace}/{v.package.name}/latest/readme/",
)
actual = response.json()

assert actual["html"] == "<h1>Very <strong>strong</strong> header</h1>\n"
expected_html = '<h1 id="user-content-very-strong-header">Very <strong>strong</strong> header</h1>\n'
assert actual["html"] == expected_html


@pytest.mark.django_db
Expand Down
2 changes: 1 addition & 1 deletion django/thunderstore/frontend/api/experimental/tests/test_markdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
this is a description
""".strip()

MARKDOWN_RENDERED = """<h1>Test markdown</h1>
MARKDOWN_RENDERED = """<h1 id="user-content-test-markdown">Test markdown</h1>
<p>this is a description</p>
"""

Expand Down
44 changes: 44 additions & 0 deletions django/thunderstore/frontend/templates/base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,50 @@
{# CSS and JS #}
<link rel="stylesheet" href="{% static 'css/all.css' %}">
<script src="{% static 'js/all.js' %}"></script>

{# Anchor navigation JS #}
<script>
function slugger(text) {
let slug = text.replace(/\s+/g, "-");
slug = slug.replace(/[^\p{L}\p{N}_-]+/gu, "");
return "user-content-" + slug.toLowerCase();
}

function scrollToHash(hash) {
if (!hash) return;

const targetId = hash.slice(1);

let target = document.getElementById(targetId);
if(!target)
{
const normalizedTarget = targetId.startsWith('user-content-') ? targetId : slugger(targetId);
target = document.getElementById(normalizedTarget);
}
Comment thread
x753 marked this conversation as resolved.

if (!target) return;

target.scrollIntoView({ behavior: "auto", block: "start" });
}

document.addEventListener('click', (e) => {
const link = e.target.closest('a[href^="#"]');
if (!link) return;

const hash = link.getAttribute('href');
if (hash) {
e.preventDefault();
scrollToHash(hash);
if (location.hash !== hash)
{
history.pushState(null, "", hash);
}
}
});

document.addEventListener("DOMContentLoaded", () => scrollToHash(location.hash));
window.addEventListener("hashchange", () => scrollToHash(location.hash));
</script>
</head>
<body>
{% if community.background_image %}
Expand Down
12 changes: 6 additions & 6 deletions django/thunderstore/markdown/allowed_tags.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,12 @@
"img": ["src", "width", "height", "alt", "align"],
"th": ["align", "rowspan", "colspan"],
"td": ["align", "rowspan", "colspan"],
"h1": ["align"],
"h2": ["align"],
"h3": ["align"],
"h4": ["align"],
"h5": ["align"],
"h6": ["align"],
"h1": ["align", "id"],
"h2": ["align", "id"],
"h3": ["align", "id"],
"h4": ["align", "id"],
"h5": ["align", "id"],
"h6": ["align", "id"],
"p": ["align"],
"details": ["open"],
}
12 changes: 11 additions & 1 deletion django/thunderstore/markdown/templatetags/markdownify.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,25 @@
from django.template.defaultfilters import stringfilter
from django.utils.safestring import mark_safe
from markdown_it import MarkdownIt
from mdit_py_plugins.anchors import anchors_plugin

from thunderstore.markdown.allowed_tags import (
ALLOWED_ATTRIBUTES,
ALLOWED_PROTOCOLS,
ALLOWED_TAGS,
)


def slugger(text: str) -> str:
import re

slug = re.sub(r"\s+", "-", text)
slug = re.sub(r"[^\w\-]", "", slug)
Comment thread
x753 marked this conversation as resolved.
return f"user-content-{slug.lower()}"
Comment thread
x753 marked this conversation as resolved.


register = template.Library()
md = MarkdownIt("gfm-like")
md = MarkdownIt("gfm-like").use(anchors_plugin, slug_func=slugger, max_level=6)


def render_markdown(value: str):
Expand Down
Loading