Skip to main content

CLI Usage

The components-to-markdown command line runner has a number of useful options. You can use npx to run it directly from the terminal to view all available options:

npx components-to-markdown@latest --help

Usage​

components-to-markdown [options] <sources...>

The <sources...> is a list of paths to directories or files to be processed.

tip

For full customization support, opt for Library Usage, which has more options, like Hooks for example.

Options​

--patterns <patterns...>​

Alias: -p.

Default:

[
  "**/*.{js,jsx,ts,tsx}",
  "!**/__tests__/**",
  "!**/*.{test,spec}.{js,jsx,ts,tsx}",
  "!**/*.d.ts"
]

File patterns to filter.

--template <template>​

Alias: -t.

Default: "brachiosaurus".

Path to template file or the name of the built-in template.

--output <output>​

Alias: -o.

Default: ".".

Path to output markdown files.

--watch​

Alias: -w.

Default: false.

Watch for changes and rebuild automatically.

--loglevel <level>​

Alias: -l.

Default: "info".

Logging level.

--grouped​

Default: false.

Components in the same file will be grouped in the same output file.

--version​

Alias: -V.

Output the version number.

--help​

Alias: -h.

Display help for command.