@recital/stage-parser-cli
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

stage-parser-cli

CLI for the recital stage parser to convert .stage files to .mdx ones

Usage

$ stage-parser-cli <infile> -o <outfile, optional> -t <template file, optional>

If no outfile is provided, the generated MDX will be output as a sibling file to the original. Do note that the file will not be a valid MDX file - it only converts the tags, and doesn't add proper Recital imports, etc. The generated MDX can be inserted into a Recital component via the MDXsource prop, which can cause your stories to be built faster.

Templating

You can use the -t flag to link an MDX file as a template for the output. The template should have the following format:


// put your imports at the beginning of the file

...

<Recital ...recitalProps >${content}</Recital>

...

where the generated output will all be created in the ${content} tag. Note that other tags will be ignored, and you should not have more than one content tag.

This is primarily used for stage-parser-cli to generate an entire MDX file that can be dropped into an MDX-supporting application, rather than just generating the MDX for the stage file's contents to put into a Recital component.

Readme

Keywords

Package Sidebar

Install

npm i @recital/stage-parser-cli

Weekly Downloads

1

Version

0.2.0

License

MIT

Unpacked Size

6.63 kB

Total Files

8

Last publish

Collaborators

  • amorphous