Skip to content
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

Document Markdown.@md_str #52734

Closed
wants to merge 1 commit into from
Closed

Document Markdown.@md_str #52734

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
22 changes: 22 additions & 0 deletions stdlib/Markdown/src/Markdown.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,28 @@ function docexpr(source::LineNumberNode, mod::Module, s, flavor = :julia)
:($doc_str($(mdexpr(s, flavor)), $(QuoteNode(source)), $mod))
end

"""
@md_str -> Markdown.MD

Construct a `Markdown.MD` object by parsing a piece of Markdown code. Some interpolation
with `$` is supported.

# Example
```jldoctest
julia> prose = md"""
# Hello!

My favourite number is $(1 + 1).
"""
Hello!
≡≡≡≡≡≡

My favourite number is 2.

julia> typeof(prose)
Markdown.MD
```
"""
macro md_str(s, t...)
mdexpr(s, t...)
end
Expand Down