Skip to content

Commit d2a2f92

Browse files
committed
Update README.md
1 parent 011e856 commit d2a2f92

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,18 @@ This is a list of parameters you can change in `local_settings.py`.
8181
| Parameter | Type | Default value | Value range | Description |
8282
| ----------------- | ------ | ------------- | ------------ | ----------- |
8383
| request | bool | True | True, False | If TRUE, requested output is processed. |
84-
| format | string | png | png | Format of the final output. Note: `OUTPUT_MOVIE` only accepts mp4. |
84+
| format | string | png | png | Format of the final output. |
8585
| doc_pad_h | int | 300 | 0 - 1000 | Left and right padding in pixels of final output. |
8686
| doc_pad_v | int | 200 | 0 - 1000 | Top and bottom padding in pixels of final output. |
8787
| doc_fill_color | string | #FFFFFF | '' | Background color of final output in 6-digit hex. |
8888
| base_stroke_color | string | #23445D | '' | Stroke color of diagram in 6-digit hex. |
8989
| base_fill_color | string | #BAC8D3 | '' | Fill color of diagram in 6-digit hex. |
9090

91+
### Notes
92+
93+
* `OUTPUT_MOVIE` currently will not be processed if the height of the full-page screenshot is >= 10,000px after it has been resized to a width of 1280px.
94+
* `OUTPUT_MOVIE` only accepts mp4 format.
95+
9196
### Example
9297

9398
This code will portfoliofy a webpage served on a web server running on a local computer. It only requests `OUTPUT_MAIN` and `OUTPUT_BROWSER` both in the default PNG format. `OUTPUT_MAIN`, `OUTPUT_MOBILES`, `OUTPUT_FULL` and `OUTPUT_VIDEO` will not be processed. But all `OUTPUT_SCREENSHOTS` will be saved. All other parameters remain set to their default values.

0 commit comments

Comments
 (0)