Skip to content

DOCS-1357 - Add more PNG/GIF parameters to Style Guide #6358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kimsauce wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −1
Open

DOCS-1357 - Add more PNG/GIF parameters to Style Guide #6358

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/contributing/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,7 +724,8 @@ You can use a link to a file embedding the entire file, or embed a range of code

1. Save your image to the `/static/img` folder. This folder structure mirrors the doc section folders.
* When updating existing images (like if there's a Sumo UI change), do not add a new version; always replace existing images. Image files take up a lot of room and can slow build times.
* File format be .png or .gif.
* File format be PNG. Avoid using animated GIFs, as they're generally not accessible; instead, use static images, provide text descriptions, or ensure animations stop within 5 seconds.
* Max file size 2MB.
1. Add the import line to the top of your doc, underneath the [front matter header](#metadata-frontmatter), if it's not already there.
```
import useBaseUrl from '@docusaurus/useBaseUrl';
Expand Down