Skip to content

docs: document the --compact flag for export-pdf#90

Open
osmarmail-prog wants to merge 1 commit into
zarazhangrui:mainfrom
osmarmail-prog:docs/document-compact-pdf-flag
Open

docs: document the --compact flag for export-pdf#90
osmarmail-prog wants to merge 1 commit into
zarazhangrui:mainfrom
osmarmail-prog:docs/document-compact-pdf-flag

Conversation

@osmarmail-prog

Copy link
Copy Markdown

What

Documents the existing --compact flag in the README's Export to PDF section.

Why

scripts/export-pdf.sh already supports --compact (renders at 1280×720 instead of 1920×1080 for a smaller file) and lists it in its own --help/usage output — but the README never mentioned it, so users couldn't discover the smaller-file option from the docs.

Change

  • Added a --compact example to the code block
  • Added a one-line note explaining what it does

No behavior change — documentation only.

The export-pdf.sh script already supports a --compact flag (1280x720,
smaller output) and lists it in its own --help/usage text, but the
README's "Export to PDF" section never mentioned it. Add an example and
a short note so users can discover the smaller-file option.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants