Commit a1c4943
3d Shapes Example Doc Fix (#21842)
# Objective
Resolve formatting issue in [3D Shapes
Example](https://bevy.org/examples/3d-rendering/3d-shapes/) page on the
Bevy Website, where an unwrapped `Assets<A>` is breaking the HTML
rendering on the page. This fix follows the standard set forth by other
`Assets<A>` instances on the page.
Fixes bevy-website issue:
bevyengine/bevy-website#2302
## Solution
Wrap `Assets<A>` as a code snippet to resolve HTML rendering issues.
Wrapping the code properly encodes the characters so they are not
interpreted as an HTML `<a>` tag.
## Testing
~~I am still working on setting up the bevy-website locally to render
the Bevy examples, so I have been unable to test this directly, but I
have set up a Zola demo project in my local environment where I was able
to reproduce and fix the behavior using the same strategy.~~
I have been able to render the examples locally with the fix, see
examples below
---
## Showcase
### Issue In Live Site
<img width="1396" height="155" alt="image"
src="https://github.com/user-attachments/assets/19fd22b0-691f-48dc-8a1e-69667a9e60f3"
/>
<img width="744" height="257" alt="image"
src="https://github.com/user-attachments/assets/829629fe-fd53-4e74-862f-112b0baa1a20"
/>
### Issue Resolve In Local Site
<img width="1384" height="165" alt="image"
src="https://github.com/user-attachments/assets/15ca531f-acf3-448c-b3ee-89b0e61ea46a"
/>
<img width="739" height="240" alt="image"
src="https://github.com/user-attachments/assets/98c49993-072e-4c8b-91cf-298934bf2114"
/>
### Issue Reproduced In Local Zola Project
<img width="1653" height="104" alt="image"
src="https://github.com/user-attachments/assets/14582277-2ece-4aba-84ad-05df1cee7aeb"
/>
<img width="704" height="94" alt="image"
src="https://github.com/user-attachments/assets/0d223645-cd2f-4623-90c2-3f6ad98c874f"
/>
### Issue Resolved In Local Zola Project
<img width="1646" height="108" alt="image"
src="https://github.com/user-attachments/assets/7c707402-8da9-4ae3-a409-16cee0c3feea"
/>
<img width="720" height="113" alt="image"
src="https://github.com/user-attachments/assets/3c96e520-9d20-48aa-8a21-8c63067263ee"
/>
Co-authored-by: Tim Pepper <[email protected]>1 parent 453b24c commit a1c4943
1 file changed
+1
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
| |||
0 commit comments