bevy/tools/example-showcase
Asier Illarramendi 7e18356da6 Split example file docblock and code when generating web examples markdown (#18191)
# Objective

Separate example explanation (file docblock) and the code so they can be
layout differently in the website and we can give a higher importance to
the explanation on the [website search
tool](https://github.com/bevyengine/bevy-website/pull/1935). This would
also allow us to improve the examples so they become even more like a
cookbook.

## Solution

Update the `example-showcase` tool to extract the example file docblock
and write it as the example markdown content. This allows us to access
the explanation via `page.content` in Zola.

## Testing

I've checked that the output is correct after running the tool and it
doesn't throw any error. I've also validated that the approach will work
on the website.

## Showcase

This is a quick and dirty example of what we could do in the web
examples after the change. When we implement the real thing we can put
the explanation on a sidebar or explore other layout options.

<img width="1362" alt="image"
src="https://github.com/user-attachments/assets/6738542e-31c3-41cd-972a-7fa2e942e85d"
/>
2025-03-19 21:36:18 +01:00
..
src Split example file docblock and code when generating web examples markdown (#18191) 2025-03-19 21:36:18 +01:00
asset-source-website.patch
Cargo.toml Upgrade to Rust Edition 2024 (#17967) 2025-02-24 03:54:47 +00:00
disable-audio.patch Remove tracing re-export from bevy_utils (#17161) 2025-01-05 23:06:34 +00:00
extra-window-resized-events.patch update CI patch for EventWriter::send deprecation (#18044) 2025-02-26 20:36:15 +00:00
fixed-window-position.patch Fix window position patch (#14745) 2024-08-15 13:55:15 +00:00
reduce-light-cluster-config.patch
remove-desktop-app-mode.patch Update hashbrown to 0.15 (#15801) 2024-12-10 19:45:50 +00:00
window-settings-wasm.patch Remove Implicit std Prelude from no_std Crates (#17086) 2025-01-03 01:58:43 +00:00