Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Aug 22, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions v4-README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 8 additions & 0 deletions v4-migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.