Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 2.33 KB

example-getting-started.md

File metadata and controls

35 lines (24 loc) · 2.33 KB

example-getting-started

Use example-getting-started to generate setup instructions for an example application.

The transform reads the package name from package.json and uses it in the build command.

Options

Option Type Default Description Notes
packageJsonPath string ./package.json Package file path relative to the destination document. None.
includeHeading boolean true Include the Getting Started heading. When enabled, the transform determines the depth from the marker position. See Generated headings.
headingLevel integer Inferred Set the context heading level from 1 through 6. This value overrides the depth inferred from the marker position.
usesTinylicious boolean true Include the Tinylicious setup steps. None.
serviceClient boolean false Include the unified ServiceClient setup steps. The Tinylicious mode is included only when usesTinylicious is true.

Examples

Markdown

The following marker generates setup instructions without Tinylicious steps:

<!-- markdown-magic:begin {"transform":"example-getting-started","usesTinylicious":false} -->
<!-- markdown-magic:end -->

MDX

For an MDX document, use MDX comments:

{/* markdown-magic:begin {"transform":"example-getting-started","usesTinylicious":false} */}
{/* markdown-magic:end */}