diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-05-07 14:15:40 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-05-07 14:19:35 -0600 |
| commit | 131d3ef70412cd4eb23c8bb627b2273a4a069d30 (patch) | |
| tree | daabbb9e04230c6db9b259d49edc781384e3681b /README.adoc | |
| parent | a1281a85bd5266a3ab6456211a014fdcda1f4506 (diff) | |
clarify the default image width setting in the README [skip ci]
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/README.adoc b/README.adoc index 9275bec0..ef13489f 100644 --- a/README.adoc +++ b/README.adoc @@ -571,7 +571,7 @@ In all cases, the width is converted to pt. === Specifying a Default Width -If you want to scale all block images that don't have a pdfwidth or scaledwidth attribute specified, assign a value to the image_width key in your theme. +To scale all block images that don't define either a `pdfwidth` or `scaledwidth` attribute on the image macro, assign a value to the image-width key in your theme file. [source,yaml] ---- @@ -579,6 +579,10 @@ image: width: 100% ---- +The image-width key accepts the same values as the `pdfwidth` attribute. +Thus, you can think of it as the fallback value for the `pdfwidth` attribute. +If specified, this value takes precedence over the `width` attribute on the image macro. + === Inline Image Sizing Inline images can be sized in much the same way as block images (using the pdfwidth, scaledwidth or width attributes), with the following exceptions: |