jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-11-15 05:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs style guide: add section on images (#2790)

Browse Source
This commit is contained in:
c0ffeeca7
2025-09-12 11:40:49 +02:00
committed by GitHub
parent 534d2ca5bb
commit ff78c93c85
2 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/documenting/create-page.md
View File

@@ -129,20 +129,20 @@ Please note, if you want to use Markdown inside an HTML block, it has to be surr
</div> </div>
``` ```
### 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, 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. 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 | | Type | Location |
| :---------- | :------------------------ | | :---------- | :------------------------ |
| blog | source/images/blog | | blog | source/images/blog |
| screenshots | source/images/integration | | screenshots | source/images/integrations/your-integration |
### Linking from the sidebar ### Linking from the sidebar

5
docs/documenting/general-style-guide.md
View File

@@ -46,6 +46,11 @@ A few notes about the use of markdown in this documentation:
1. List item 2. 1. List item 2.
1. List item 3. 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 ## YAML and templates