Skip to content
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.

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

Create syntax for icons #409

Open
Mpdreamz opened this issue Feb 4, 2025 · 2 comments
Open

Create syntax for icons #409

Mpdreamz opened this issue Feb 4, 2025 · 2 comments
Labels
authoring Relates to our markdown parser design

Comments

@Mpdreamz
Copy link
Member

Mpdreamz commented Feb 4, 2025

Today icons are referenced manually e.g:

:: warn: Documentation.Builder.Log[0] External URI 'https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png' is not allowed. Add 'amazonaws.com' to the 'external_hosts' list in the configuration file '/github/workspace/docset.yml' to allow links to this domain. (/github/workspace/solutions/search/cross-cluster-search.md:1122)
:: warn: Documentation.Builder.Log[0] External URI 'https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png' is not allowed. Add 'amazonaws.com' to the 'external_hosts' list in the configuration file '/github/workspace/docset.yml' to allow links to this domain. (/github/workspace/solutions/search/cross-cluster-search.md:1122)

Once we settle on a UI framework and icon pack we should make it easy to add icons through e.g :yes: and :no: inline syntax.

That way we can ensure these match the style and light/dark theme.

@Mpdreamz Mpdreamz added authoring Relates to our markdown parser design labels Feb 4, 2025
@reakaleek
Copy link
Member

reakaleek commented Feb 4, 2025

Tailwind's icon pack https://heroicons.com/
tabler-icons https://tablericons.com/

Just posting some icon packs that provide the svg.

@bmorelli25
Copy link
Member

There could be value in eventually providing support for Elastic product and app logos as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authoring Relates to our markdown parser design
Projects
None yet
Development

No branches or pull requests

3 participants