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.

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

Markdown documentation should explain the md string macro. #51168

Closed
DrEntropy opened this issue Sep 3, 2023 · 3 comments
Closed

Markdown documentation should explain the md string macro. #51168

DrEntropy opened this issue Sep 3, 2023 · 3 comments
Labels
domain:docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia stdlib:markdown

Comments

@DrEntropy
Copy link

[Markdown] (https://github.com/JuliaLang/julia/blob/master/stdlib/Markdown/docs/src/index.md) documentation should have a section on the existence and use of the md"##Markdown Here" string macro. As a newbie I ran into this syntax and could not figure out what it was! I suppose it is obvious what it does from experimentation, but I could not find any documentation.

PS: I ran into it when I was toying around with Pluto.js where this macro is used extensively.

@fredrikekre fredrikekre added stdlib:markdown domain:docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia labels Sep 3, 2023
@krishjoshi7
Copy link

can you please explain what string macro does

@DrEntropy
Copy link
Author

Perhaps that is not the right terminology.... the documentation calls them "Nonstandard string literals". But it is syntactic sugar for a macro call: md"Blah" turns into @md_str("blah").

mitiemann added a commit to mitiemann/julia that referenced this issue Dec 28, 2023
fixed tailing blank lines

added an example

added suggestion from reviewer stevengj
mitiemann added a commit to mitiemann/julia that referenced this issue Dec 31, 2023
fixed tailing blank lines

added an example

added suggestion from reviewer stevengj
mitiemann added a commit to mitiemann/julia that referenced this issue Jan 2, 2024
mitiemann added a commit to mitiemann/julia that referenced this issue Jan 2, 2024
mitiemann added a commit to mitiemann/julia that referenced this issue Jan 2, 2024
mitiemann added a commit to mitiemann/julia that referenced this issue Jan 3, 2024
mitiemann added a commit to mitiemann/julia that referenced this issue Jan 3, 2024
mitiemann added a commit to mitiemann/julia that referenced this issue Jan 3, 2024
mitiemann added a commit to mitiemann/julia that referenced this issue Jan 4, 2024
mitiemann added a commit to mitiemann/julia that referenced this issue Jan 4, 2024
mitiemann added a commit to mitiemann/julia that referenced this issue Jan 4, 2024
stevengj added a commit that referenced this issue Jan 6, 2024
This PR addresses #51168 . I guess this PR wants to have the labels doc
& markdown .

---------

Co-authored-by: Steven G. Johnson <[email protected]>
Co-authored-by: Jameson Nash <[email protected]>
Co-authored-by: Steven G. Johnson <[email protected]>
@stevengj
Copy link
Member

stevengj commented Jan 6, 2024

Closed by #52606

@stevengj stevengj closed this as completed Jan 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation good first issue Indicates a good issue for first-time contributors to Julia stdlib:markdown
Projects
None yet
Development

No branches or pull requests

4 participants