Skip to content

docs: mention /icons in the template documentation #10230

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

Merged
merged 6 commits into from
Oct 12, 2023
Merged

docs: mention /icons in the template documentation #10230

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
59b88cf
docs: mention /icons
aslilac Oct 11, 2023
34da7eb
add an image
aslilac Oct 11, 2023
2de4355
bundled
aslilac Oct 12, 2023
dc0c569
incorporate some suggestions
aslilac Oct 12, 2023
1b7cd8d
add an `option`, for fun
aslilac Oct 12, 2023
574d302
add some thoughts about external icons
aslilac Oct 12, 2023
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
Prev Previous commit
add some thoughts about external icons
  • Loading branch information
@aslilac
aslilac committed Oct 12, 2023
commit 574d30259b17c4c317f136c7985df7efc0085368
28 changes: 23 additions & 5 deletions docs/templates/icons.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,30 @@ come bundled with your Coder deployment.

## Bundled icons

Coder includes icons for popular cloud providers and programming languages. You
can see all of the icons (or suggest new ones) in our repository on
Coder is distributed with a bundle of icons for popular cloud providers and
programming languages. You can see all of the icons (or suggest new ones) in our
repository on
[GitHub](https://github.com/coder/coder/tree/main/site/static/icon).

You can also view the entire list, with search, by navigating to /icons on your
Coder deployment. E.g. [https://coder.example.com/icons](#). This can be
particularly useful in airgapped deployments.
You can also view the entire list, with search and previews, by navigating to
/icons on your Coder deployment. E.g. [https://coder.example.com/icons](#). This
can be particularly useful in airgapped deployments.

![The icon gallery](../images/icons-gallery.png)

## External icons

You can use any image served over HTTPS as an icon, by specifying the full URL
of the image. We recommend that you use a CDN that you control, but it can be
served from any source that you trust.

You can also embed an image by using data: URLs.

- Only the https: and data: protocols are supported in icon URLs (not http:)

- Be careful when using images hosted by someone else; they might disappear or
change!

- Be careful when using data: URLs. They can get rather large, and can
negatively impact loading times for pages and queries they appear in. Only use
them for very small icons that compress well.