Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.07 KB

include-code.md

File metadata and controls

55 lines (39 loc) · 2.07 KB

include-code

Use include-code to add text from another file to a fenced code block.

Options

Option Type Required Description
path string Yes Source path relative to the destination document.
start integer No Zero-based index of the first source line to include.
end integer No Zero-based index after the last source line to include.
language string No Language identifier for the code fence.

start is inclusive. end is exclusive. Negative indexes use JavaScript array-slice rules and count backward from the end of the source. A terminal line ending creates an empty final entry and affects negative indexes. The transform removes leading and trailing whitespace from the selected text.

If language is absent, the transform creates a code fence without a language identifier.

Examples

Markdown

The following marker includes TypeScript source after the first five lines:

<!-- markdown-magic:begin {"transform":"include-code","path":"./example.ts","language":"typescript","start":5} -->
<!-- markdown-magic:end -->

The following marker includes the last two lines from a source that ends with a line ending:

<!-- markdown-magic:begin {"transform":"include-code","path":"./example.ts","language":"typescript","start":-3,"end":-1} -->
<!-- markdown-magic:end -->

MDX

For an MDX document, use MDX comments. The following marker includes TypeScript source after the first five lines:

{/* markdown-magic:begin {"transform":"include-code","path":"./example.ts","language":"typescript","start":5} */}
{/* markdown-magic:end */}

The following marker includes the last two lines from a source that ends with a line ending:

{/* markdown-magic:begin {"transform":"include-code","path":"./example.ts","language":"typescript","start":-3,"end":-1} */}
{/* markdown-magic:end */}