Skip to content
This repository was archived by the owner on Apr 21, 2026. It is now read-only.

Commit af1975b

Browse files
author
dpatanin
committed
update readme
1 parent 475f0c3 commit af1975b

1 file changed

Lines changed: 37 additions & 2 deletions

File tree

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,45 @@ Used Fonts:
6666

6767
### Icons & Images
6868

69-
Icons should be license free and as close to the other icons' style as possible. They should be outlined and monochrome. Color should only be used to fill, never as line color, and only if color does provide a more pleasing look than monochrome. Images should be fitting and mainly used as background (partially). They should fit the color scheme if possible or do **not** stand out through a high contrast to the website. Recommended websites for free icons or images:
69+
Icons should be license free and as close to the other icons' style as possible. They should be outlined and monochrome. Color should only be used to fill, never as line color, and only if color does provide a more pleasing look than monochrome. Images should be fitting and mainly used as background (partially). They should fit the color scheme if possible or do **not** stand out through a high contrast to the website. Currently we use svg images from [undraw](https://undraw.co/) as background images. In the case you are going to use a png, jpg or jpeg, and it does not load in an instant, use gatsby-image and fluid to avoid a spontaneously popping image, e.g.:
70+
71+
Query the image on the page:
72+
73+
```javascript
74+
export const query = graphql`
75+
query {
76+
ImageHomeQuery: file(relativePath: { eq: "images/<ImageName.any>" }) {
77+
childImageSharp {
78+
# Specify the image processing specifications right in the query.
79+
fluid {
80+
...GatsbyImageSharpFluid
81+
}
82+
}
83+
}
84+
}
85+
`;
86+
```
87+
88+
And use the `<Img/>` component:
89+
90+
```html
91+
<div className="background-plane">
92+
<img
93+
fluid="{props.data.ImageHomeQuery.childImageSharp.fluid}"
94+
alt="secureCodeBox preview"
95+
objectFit="cover"
96+
className="background-image"
97+
/>
98+
</div>
99+
```
100+
101+
Of course you can use this not only for background images, just ignore then everything related to to background in the example. However, currently, the intro style class provides basic styling for the background images.
102+
103+
Recommended websites for free icons or images:
70104

71105
- [iconmonstr](https://iconmonstr.com/)
72106
- [pixabay](https://pixabay.com/)
107+
- [undraw](https://undraw.co/)
73108

74109
## Documentation Guide
75110

@@ -238,7 +273,7 @@ Currently under development, this will be the guide for our "Get Started" tutori
238273

239274
#### Developer docs
240275

241-
Currently under development, this will be the guide for our "Docs" developer documentation similar to the ones above.
276+
Currently under development, this will be the guide for our "Docs" developer documentation similar to the ones above.
242277

243278
## Production Deployment
244279

0 commit comments

Comments
 (0)