Table of Contents

Editing Images

Jarratt Isted Updated by Jarratt Isted

We've got a bunch of options to help you format your images and make them look stellar in your docs 🌠

You're able to change image size, alignment, send folks to a different page, or make them more accessible by adding alt text.

Wanna learn how to insert images instead? This article will help you out

Changing the Image Size

  1. Click on the image to see the Edit Image menu
  2. Type in the Maximum Height and Maximum Width of your image
  3. Click Apply Changes
  4. Hit Save
Any valid CSS string will work like 100px,Β 75%, orΒ 2em

Changing Image Alignment

  1. Click on the image to see the Edit Image menu
  2. Click the Alignment dropdown
  3. Choose between Automatic, Left, Center, or Right
  4. Click Apply Changes
  5. Hit Save
When you change image size or alignment, the text editor won't show what your customers see. Hit the Preview button to see the changes
  1. Click the image to see the Edit Image menu
  2. Paste the URL in the Link to URL field
  3. Click Apply Changes
  4. Hit Save

Adding Alt Text

πŸ“— Read about the alt tag and accessibility on images over here
  1. Click the image to see the Edit Image menu
  2. Expand the Image section by clicking its heading
  3. Describe the image in the Alt Text box
  4. Click Apply Changes
  5. Hit Save

Replacing an Image by URL

  1. Click the image to see the Edit Image menu
  2. Expand the Image section by clicking its heading
  3. Paste your new image URL into the External Image URL field
  4. Click Apply Changes
  5. Hit Save

Replacing an Image by Upload

  1. Click the image to see the Edit Image menu
  2. Expand the Image section by clicking its heading
  3. To upload your new image either...
    1. ...drag and drop it into the dotted area
    2. ...click the dotted area and choose an image to upload
  4. Click Apply Changes
  5. Hit Save

Copying an External Image into HelpDocs

If you're using images from an outside source we recommend copying them to HelpDocs so they won't disappear or change πŸ‘»
  1. Click your externally hosted image to see the Edit Image menu
  2. Expand the Image section by clicking its heading
  3. Click Copy into HelpDocs
  4. Wait for the upload to finish and the preview to update
  5. Click Apply Changes
  6. Hit Save

What did you think of this doc?

Previewing Articles

Get in touch