Title here
Summary here
Getting Started
Images is the official images integration for the Hyas framework. This guide will help you get started with Images already installed. See the manual setup instructions to add Images to an existing Hyas project.
Quick start
To follow this guide, you’ll need an existing Hyas project with Images installed.
Check if Images is installed
Check if Images is installed by running the following command in your project’s root directory:
This will print the version of the package installed. If nothing is printed, you’ll first need to add Images — proceed with the manual setup instructions.
Add images
Images is installed and it’s time to add some images!
- Add images to your
.mdpages by using Markdown or by using theimg,picture, orfigureshortcode. - Add images to your
htmlpages by using the theimg,picture, orfigurepartial.
Next steps
- Resources: Learn where to store your images in the “Resource Locations” guide.
- Shortcodes: Get started with the “img”, “picture”, and “figure” shortcode guides.
- Partials: Get started with the “img”, “picture”, and “figure” partial guides.
Updating Images
Images is a Hyas integration, and is updated like any @hyas/* integration (or theme):
See the Images changelog for a full list of the changes made in each release.
Troubleshooting Images
Use the project configuration, shortcodes (“img”, “picture”, and “figure”), and partials (“img”, “picture”, and “figure”) reference pages to ensure that images is configured and functioning properly. See the guides in the sidebar for help storing images and customizing your Images setup.
If your answer cannot be found in these docs, please visit the full Hyas Docs for complete Hyas documentation. Your question may be answered by understanding how Hyas works in general, underneath this Images integration.
You can also check for any known Images issues on GitHub, and get help in Hyas Discussions from our active, friendly community!
Credits
All photos on this site are by Vincent van Zalinge.
All illustrations on this site are by Franziska Höllbacher.
This npm package is based on:
Next
Manual Setup