Uploading images

# How to upload images?

When using images, you don't always have access to a URL.

That's why Gendocs supports image uploading.

To upload an image just use the relative url to the image starting from the root.

# Example

Imagine:

assets/
  image.jpg

docs/
  getting_started.md

gendocs.json
gendocs-token

In getting_started.md

markdown

![some alt tag for the visually impaired](assets/image.jpg)

# Best practice

We recommend making an assets folder or an images folder like the example above.

This keeps your directory clean and makes sure you know where all your images are.

# Upload limit

The maximum size of images is 5 megabytes.

If you need images that are bigger than 5MB we suggest using another service to upload these images.

# Example

Imagine:

assets/
  image.jpg

docs/
  getting_started.md

gendocs.json
gendocs-token