Skip to content

Commit

Permalink
Added documentation for the Markdown Macro (#52607)
Browse files Browse the repository at this point in the history
Co-authored-by: Jameson Nash <[email protected]>
  • Loading branch information
mokshablr and vtjnash authored Feb 7, 2024
1 parent e22db88 commit d765ad1
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions stdlib/Markdown/docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,16 @@ If no title text is specified after the admonition type, then the type name will

Admonitions, like most other toplevel elements, can contain other toplevel elements (e.g. lists, images).

## [Markdown String Literals](@id stdlib-markdown-literals)

The `md""` macro allows you to embed Markdown strings directly into your Julia code.
This macro is designed to simplify the inclusion of Markdown-formatted text within your Julia source files.

### Usage

```julia
result = md"This is a **custom** Markdown string with [a link](http://example.com)."
```
## Markdown Syntax Extensions

Julia's markdown supports interpolation in a very similar way to basic string literals, with the
Expand All @@ -403,9 +413,6 @@ complex features (such as references) without cluttering the basic syntax.
In principle, the Markdown parser itself can also be arbitrarily extended by packages, or an entirely
custom flavour of Markdown can be used, but this should generally be unnecessary.

## [Markdown String Literals](@id stdlib-markdown-literals)

Markdown strings can be constructed using the string literal syntax `md"..."`.

## [API reference](@id stdlib-markdown-api)

Expand Down

0 comments on commit d765ad1

Please sign in to comment.