You can insert images in the body of your help center knowledge base articles and content blocks. When you insert images, they are added as attachments. Large images are automatically resized to fit the width of the article.
This article contains the following sections:
- Inserting images into articles
- Inserting images into content blocks
- Optimizing help center images for the Web Widgets
Inserting images into articles
You can insert images into articles using the following procedure. Be sure to insert the image, as opposed to copying and pasting the image from another source, to avoid image issues. As an alternative to inserting images directly in your articles, you can host your images on a public file server and link to them.
To insert an image in an article
- In help center or Guide Admin, create a new article or edit an existing article.
- Place the cursor where you want the image to appear.
- Do one of the following:
- Drag and drop the image into the body of the article.
- Click the Insert image button on the toolbar, then click Upload images and select your image.
The image file size limit is 20 MB.
Images are automatically adjusted to fit the width of the article, using a compression feature within CSS. It's a good idea to manually resize images that are more than 1600px wide before you insert them, as the compression might cause the image to appear distorted in the published article. You also might want to manually resize images if you are using Web Widget (see Optimizing images for Web Widget below).
- Click Insert in the dialog that appears.
The image appears in your article.
- Click Save.
If you have a closed help center that requires all users to sign-in, article images will appear broken in email notifications sent to users who are following your help center.
Inserting images into content blocks (Enterprise plans only)
Content blocks enable you to create content that you can share between multiple articles. You can insert images into content blocks in a similar manner to how you include them in help center articles. You can add up to 50 images per content block.
To insert images into content blocks
- In help center or Guide Admin, create a new content block or edit an existing content block
- In the content block, place the cursor where you want the image to appear.
- Click the Add image icon () on the content block toolbar.
Alternatively, you can drag and drop an image into the content block.
- In the image gallery, choose the images you want to upload or click Upload image if you want to add a new image to the gallery.
Alternatively, you can drag and drop an image into the image gallery. The image file size limit is 20 MB.Note: You can filter the displayed images by clicking the options in the left-side menu. For more information about the image gallery, see Working with the image gallery for content blocks.
- Click Insert image.
The images you selected appear in your content block.
You can click the image to display a toolbar, where you can select one of three image display sizes and enter alternative (ALT) text to improve the accessibility of your article. You can also resize the image by dragging the corner of the image to the size that you want.
- If this is a new content block, click Create. If you're updating an existing content block, click Update.
Limitations for images in content blocks
Currently, the following limitations apply when adding images to content blocks:
- You can't copy and paste images between content blocks and articles.
- If you unlink a content block (so that it becomes part of the article), any images will be removed. You'll need to add them again.
- When you create a content block by copying from an article with an image, the image won't be added to the content block. You must add the image manually.
Optimizing help center images for the Web Widgets
To make sure the images in your help center articles display correctly in the messaging Web Widget and Web Widget (Classic), it’s important that the images are added to the article at the desired size.
When help center articles are converted for viewing in the widgets, the article’s images are stripped of their attributes in the HTML tags (except for the src and alt attributes), and custom CSS rules are ignored. For most images, this isn’t a problem. However, if the original images are very big, and significantly resized in the HTML or in a custom CSS, they can appear awkwardly large.
Say, for example, you want to display an icon in your help center article. The icon’s original image is 300x300 pixels. To display it at a more reasonable size, the HTML is modified by adding the attributes
In the help center article, the icon is 18x18 pixels, 6% of the actual image size. When the article is processed for the widget, and the width and height attributes are removed, it goes back to its original size and, even after being sized down to fit inside the widget, it’s too big for an icon.
Simply resizing the original image down to the size you want, rather than manipulating the size in your code, avoids this problem.