Skip to content

Commit

Permalink
docs: make clear of the relative path generated from 'output' input
Browse files Browse the repository at this point in the history
  • Loading branch information
rlespinasse committed Jul 20, 2023
1 parent 7a097bb commit 664c207
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Expand Up @@ -69,12 +69,16 @@ Path to the drawio files to export. Default `"."`.

Exported format. Default `"pdf"`.

Possible values: adoc, md, jpg, pdf, png, svg, vsdx, xml
Possible values: `adoc`, `md`, `jpg`, `pdf`, `png`, `svg`, `vsdx`, `xml`

### `output`

Exported folder name. Default `"export"`.

> **Relative from the exported drawio file**
>
> A file from `/path/to/file.drawio` will be exported to `/path/to/export/file-{page}.{ext}` by default.
### `remove-page-suffix`

Remove page suffix when possible (in case of single page file)
Expand All @@ -89,11 +93,11 @@ Scales the diagram size

### `width`

Fits the generated image/pdf into the specified width, preserves aspect ratio
Fits the generated `image/pdf` into the specified width, preserves aspect ratio

### `height`

Fits the generated image/pdf into the specified height, preserves aspect ratio
Fits the generated `image/pdf` into the specified height, preserves aspect ratio

### `crop`

Expand Down

0 comments on commit 664c207

Please sign in to comment.