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.

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

Jump to bottom

Unescaped HTML rendered in /crate page #2725

Open
gbj opened this issue Jan 17, 2025 · 2 comments · May be fixed by #2726
Open

Unescaped HTML rendered in /crate page #2725

gbj opened this issue Jan 17, 2025 · 2 comments · May be fixed by #2726

Comments

@gbj
Copy link

gbj commented Jan 17, 2025 •
edited
Loading

I have a crate that does HTML rendering, and therefore uses HTML tags within backticks at several points in its crate-level doc comments.

i.e., it opens

//! # Leptos Meta
//!
//! Leptos Meta allows you to modify content in a document’s `<head>` from within components
//! using the [`Leptos`](https://github.com/leptos-rs/leptos) web framework.

This is correctly rendered as Markdown with the HTML in backticks escaped at docs.rs/leptos_meta

<p>Leptos Meta allows you to modify content in a document’s <code>&lt;head&gt;</code> from within components
using the <a href="https://github.com/leptos-rs/leptos"><code>Leptos</code></a> web framework.</p>

But it is injected directly into the page as plain text, not rendered to Markdown and therefore containing unescaped HTML at docs.rs/crate/leptos_meta:

<div class="pure-u-1 pure-u-sm-17-24 pure-u-md-19-24 package-details" id="main">
   # Leptos Meta
    
  Leptos Meta allows you to modify content in a document’s `<head>` from within components
   using the [`Leptos`](https://github.com/leptos-rs/leptos) web framework.

This causes rendering issues, as can be seen by navigating to the two pages.

Because the Content-Security Policy would prevent any <script> tag from executing, I don't think there's any security issue here, just the rendering one.

It's also possible I'm doing something wrong and this is documented somewhere, in which case a pointer to those docs would be helpful so I can fix it.
@gbj gbj mentioned this issue Jan 17, 2025
Closed
@GuillaumeGomez
Copy link
Member

Ah interesting, sounds like an issue on our end! Gonna send a fix soon.

@GuillaumeGomez GuillaumeGomez linked a pull request Jan 17, 2025 that will close this issue
Open
@GuillaumeGomez
Copy link
Member

Fixed in #2726.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix crate-level docs not being rendered correctly if there is no readme: GuillaumeGomez/docs.rs
2 participants
@gbj @GuillaumeGomez