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

Alert blocks do not render on pub.dev generated docs #3819

Closed
JaffaKetchup opened this issue Jul 12, 2024 · 4 comments
Closed

Alert blocks do not render on pub.dev generated docs #3819

JaffaKetchup opened this issue Jul 12, 2024 · 4 comments
Labels
area-web-design Something a web designer interested in helping could do. P2 A bug or feature request we're likely to work on type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@JaffaKetchup
Copy link
Contributor

Not sure if this is the best place for the issue, please transfer if necessary.

When generating locally, the markdown alert blocks appear correctly:

image

However, in the generated documentation for a pub.dev package, the blocks do not render:

image

@parlough
Copy link
Member

\cc @isoos I know pub.dev manually replicates some of dartdoc's styles, is this just something missing from that?

@isoos
Copy link
Contributor

isoos commented Jul 13, 2024

We do support them, so this seems to be a bug. Was there any change in the output format or styles that dardoc is using? We've just released a new site version with dartdoc 8.0.10...

@JaffaKetchup JaffaKetchup changed the title Alert blocks appear to be invisible on pub.dev generated docs Alert blocks do not render on pub.dev generated docs Jul 13, 2024
@isoos
Copy link
Contributor

isoos commented Jul 15, 2024

I've found the culprit: pub.dev executes dartdoc with the --sanitize-html flag, and when that is on, the sanitization removes the alert block's div and related styles.

@srawlins srawlins added type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) P2 A bug or feature request we're likely to work on area-web-design Something a web designer interested in helping could do. labels Jul 15, 2024
@srawlins
Copy link
Member

Fixed by #3820

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-web-design Something a web designer interested in helping could do. P2 A bug or feature request we're likely to work on type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

No branches or pull requests

4 participants