@embed Directive

The @embed directive includes content from external files into your Meld document.

Syntax

@embed [path]
@embed [path # section_text]
@embed [path] as ###
@embed [path # section_text] as ###
@embed [path] under header_text

Where:

path is the path to the file to embed (can use path variables)
section_text is optional text that identifies a specific section to extract
### is an optional heading level (number of # characters) for the embedded content
header_text is optional text to use as a header for the embedded content

The path can be:

You can extract specific sections from Markdown files using the # symbol:

@embed [guide.md # Getting Started]

This will extract only the section titled "Getting Started" from guide.md.

You can adjust the heading level of embedded content using the as keyword:

@embed [guide.md] as ###

This will increase all headings by the specified number of # characters.

You can add a header to embedded content using the under keyword:

@embed [code.js] under Example Code

This will add a header "Example Code" above the embedded content.

Path, section, and header parameters can all contain variables:

@text section = "Getting Started"
@text header = "Code Example"
@embed [$docs/guide.md # {{section}}] under {{header}}

The implementation handles these error scenarios:

Basic file embedding:

@embed ["$PROJECTPATH/README.md"]

Embedding with path variables:

@path docs = "$PROJECTPATH/docs"
@embed [$docs/guide.md]

Embedding specific sections:

@embed [$docs/api.md # Authentication]

Adjusting heading levels:

@embed [$docs/guide.md] as ##

Adding headers:

@embed [$src/example.js] under Code Example