Skip to main content

Documentation Guidelines

Here you can find templates for Documentation pages, FAQ, guidelines for images, features and how to use markdown. Access the links below to navigate:

→ Access DOC guidelines
→ Access FAQ guidelines
→ Access Markdown features

The best image format for performance is Webp

To convert and compress images, you can install cwebp conversion tool as described in Homebrew Webp:
brew install webp

See more information in Google Developers WebP page.

For example, to convert an image from PNG to WEBP, first you need to be in the folder where the image is and run:
cwebp -q 75 original.jpg -o converted.webp

Change original.jpg to your desired original image file.
Rename converted.webp into your preferred filename, but you must keep the .webp extension at the end.

NOTE

q 75 refers to the compression rate.
If you use -q 50, you get a more reduced image size than a -q 75 compression. However, reduced image size may also result in more loss of image quality, so depending on your image quality needs, you should test the compression rate and check against your image quality. For example, if you want the best compression quality, you should use -q 100.