From ff78c93c854432e01a831ca623068aa3dc8eb849 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Fri, 12 Sep 2025 11:40:49 +0200 Subject: [PATCH] Docs style guide: add section on images (#2790) --- docs/documenting/create-page.md | 10 +++++----- docs/documenting/general-style-guide.md | 5 +++++ 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/documenting/create-page.md b/docs/documenting/create-page.md index a953ff42f..5894c7a04 100644 --- a/docs/documenting/create-page.md +++ b/docs/documenting/create-page.md @@ -129,20 +129,20 @@ Please note, if you want to use Markdown inside an HTML block, it has to be surr ``` -### Images, icons and logos +### Images, icons, and logos -Having a logo with the integration, makes an integration quickly identifiable with the end-user. +Having a logo with the integration makes an integration quickly identifiable with the end-user. From the documentation side of things, no specific configuration is needed to enable the use of a logo, however, the logo must exist in our Brands repository. -To add a logo and icon for your integration, open up a pull request at: the [Home Assistant Brands](https://github.com/home-assistant/brands). +- To add a logo and icon for your integration, open up a pull request at: the [Home Assistant Brands](https://github.com/home-assistant/brands). -Other images, displayed on the pages, are stored in various directories according to their purpose: +- To add other images, displayed on the integration page or any other documentation page, store the image in the corresponding directory according to their purpose: | Type | Location | | :---------- | :------------------------ | | blog | source/images/blog | -| screenshots | source/images/integration | +| screenshots | source/images/integrations/your-integration | ### Linking from the sidebar diff --git a/docs/documenting/general-style-guide.md b/docs/documenting/general-style-guide.md index 794fe6c45..39ebd6313 100644 --- a/docs/documenting/general-style-guide.md +++ b/docs/documenting/general-style-guide.md @@ -46,6 +46,11 @@ A few notes about the use of markdown in this documentation: 1. List item 2. 1. List item 3. ``` +## Images + +If you use images, upload them to the images folder in the documentation repository. Do not link to external images, for example on your private GitHub repository. + +See also the [section on images and integration logos](https://developers.home-assistant.io/docs/documenting/create-page#images-icons-and-logos). ## YAML and templates