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

Treat images as figures by default, and add a border etc #2358

Closed
chalin opened this issue Feb 17, 2023 · 2 comments · Fixed by #2359
Closed

Treat images as figures by default, and add a border etc #2358

chalin opened this issue Feb 17, 2023 · 2 comments · Fixed by #2359
Assignees
Labels
design/style Front-end site design / styling

Comments

@chalin
Copy link
Contributor

chalin commented Feb 17, 2023

After investigating

I came to realize that most images (95+%) in the website pages could benefit from a border.

Content authors often embed figures as images in pages, like this:

![A sample Kafka Broker metric shown on Prometheus](prometheus.png)

IMHO, the main "use case" of an image in markdown is as an embedded figure as illustrated above. As such, images should be treated as block elements and always have a border by default.

This could be addressed by defining an image render hook that actually encodes an image as a figure, or possibly just some styling defaults.

@chalin chalin added the design/style Front-end site design / styling label Feb 17, 2023
@chalin chalin self-assigned this Feb 17, 2023
@chalin
Copy link
Contributor Author

chalin commented Feb 17, 2023

@chalin
Copy link
Contributor Author

chalin commented Feb 20, 2023

As a possible followup to #2359, it might be good to generalize the class name img-initial to, say, otel-initial so that it can be more broadly used. Cf. google/docsy#1431

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design/style Front-end site design / styling
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant