docs(v4): update README and migration guide (#568)

Lednerb · Aug 22, 2023 · 3fb148f · 3fb148f
1 parent 01ecf2b
commit 3fb148f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/v4-README.md b/v4-README.md
@@ -490,8 +490,10 @@ gallery: [
 
 ### Image Modal Zoom
 
-When you include an image that is larger than the content area, the image becomes interactive, and a larger version can
-be opened in a lightbox.
+When you include an image larger than the content area, the image becomes interactive, and a larger version can be
+opened in a lightbox. Modal zoom will work only for images that are added using the standard markdown
+annotation, e.g., `![Image alt text](/my_image.png)` or `![Image alt text](/my_image.png "Image figure caption")` for
+images with a figure caption. Please note that this feature will not work for images added using raw HTML.
 
 ### Featured Image
 

diff --git a/v4-migration-guide.md b/v4-migration-guide.md
@@ -36,4 +36,12 @@ the `_variables.scss` file no longer exists and such customization is done in th
 corresponding parameters from the `assets/sass/theme.scss` file, for example, `baseColor`, `headlineFont` etc.
 Therefore, any changes you made in `_variables.scss` file should be ported to your site's configuration file. Read
 the [Colors and Fonts](v4-README.md#colors-and-fonts) section in the `v4` **README** guide for more details.
+
+### Image Modal Zoom
+
+The Magnific Popup plugin that provided a lightbox for displaying larger images was replaced with
+the [DimBox](https://dimboxjs.com/) plugin. Also, the built-in Hugo's rendering of images added using standard markdown
+annotation was overridden to accommodate the DimBox plugin and images with a figure caption. The `v4` no longer
+supports the modal zoom for the images added using the raw HTML. The modal zoom may work for such images if you enrich
+corresponding raw HTML elements with DimBox's attributes.