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.
| 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. |
The following marker generates setup instructions without Tinylicious steps:
<!-- markdown-magic:begin {"transform":"example-getting-started","usesTinylicious":false} -->
<!-- markdown-magic:end -->For an MDX document, use MDX comments:
{/* markdown-magic:begin {"transform":"example-getting-started","usesTinylicious":false} */}
{/* markdown-magic:end */}