Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.61 KB

dependency-guidelines.md

File metadata and controls

30 lines (20 loc) · 1.61 KB

dependency-guidelines

Use dependency-guidelines to generate the Fluid Framework dependency guidelines from the shared template.

Options

Option Type Default Description Notes
includeHeading boolean true Include the Using Fluid Framework libraries heading. When enabled, the transform determines the depth from the marker position and adjusts template headings relative to it. See Generated headings.
headingLevel integer Inferred Set the context heading level from 1 through 6. This value overrides the inferred depth. The transform adjusts template headings relative to this value.

Examples

Markdown

The following marker generates a level-two section:

<!-- markdown-magic:begin {"transform":"dependency-guidelines","headingLevel":2} -->
<!-- markdown-magic:end -->

MDX

For an MDX document, use MDX comments:

{/* markdown-magic:begin {"transform":"dependency-guidelines","headingLevel":2} */}
{/* markdown-magic:end */}