Skip to content

Serialize MarkdownAST nodes via Markdown.jl when getting hash for admonitions #2710

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
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Serialize MarkdownAST nodes via Markdown.jl when getting hash for admonitions #2710

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8707ddc
Serialize MarkdownAST node via Markdown.jl instead
asinghvi17 May 9, 2025
9d8361f
use MDFlatten for now
asinghvi17 May 10, 2025
35bd02f
Merge branch 'master' into as/robust-admonitioning
fingolfin Nov 4, 2025
33a74f9
Delete unneeded helper function
asinghvi17 Nov 4, 2025
adc9931
just run `strip(mdflatten(...))`
asinghvi17 Nov 4, 2025
82711e5
Apply suggestion from @asinghvi17
asinghvi17 Nov 4, 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
8 changes: 7 additions & 1 deletion src/html/HTMLWriter.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2484,6 +2484,12 @@ function domify(dctx::DCtx, node::Node, f::MarkdownAST.FootnoteDefinition)
return DOM.Node[]
end

# This function provided by Michael Goerz in https://github.com/JuliaDocs/MarkdownAST.jl/issues/18
function _markdownast_to_str(node::MarkdownAST.Node)
text = Documenter.MDFlatten.mdflatten(node)
Copy link
Collaborator

@fingolfin fingolfin Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file has using ...MDFlatten: mdflatten so you can write

Suggested change
text = Documenter.MDFlatten.mdflatten(node)
text = mdflatten(node)

but at that point I wonder: why even bother with this helper?

return strip(text)
end

function domify(dctx::DCtx, node::Node, a::MarkdownAST.Admonition)
@tags header div details summary
colorclass =
Expand Down Expand Up @@ -2514,7 +2520,7 @@ function domify(dctx::DCtx, node::Node, a::MarkdownAST.Admonition)
# apply a class
isempty(cat_sanitized) ? "" : ".is-category-$(cat_sanitized)"
end
node_repr = sprint(io -> show(io, node))
node_repr = _markdownast_to_str(node)
content_hash = string(hash(node_repr), base = 16)
admonition_id = if !isempty(a.title)
base_id = Documenter.slugify(a.title)
Expand Down
Loading