Skip to content

docs: add a showcase gallery with screenshots - #17

Merged
Jalkhov merged 2 commits into
stablefrom
docs/showcase
Nov 15, 2026
Merged

Jalkhov merged 2 commits into
stablefrom
docs/showcase

Conversation

@Jalkhov

@Jalkhov Jalkhov commented Nov 15, 2026

Copy link
Copy Markdown
Member

What

  • Add a Showcase page to the docs with screenshots of the four example sites
  • Show two of them (blog and handbook) in the README, linked to the gallery
  • Add the four screenshots under docs/assets/showcase/

Why

Closes #16. The issue asks for out-of-the-box sites in the README; showing the examples makes the themes concrete without bloating the PyPI page.

Notes

  • The README uses absolute raw.githubusercontent.com/.../stable/... URLs because PyPI does not resolve relative paths. The images will 404 in the branch view until this is merged.
  • Screenshots are 1280x800 PNGs, all under 190 KB.

- Add a Showcase page with screenshots of the four example sites
- Link every screenshot to its source under examples/
- Register the page in the navigation
- Embed the blog and handbook screenshots with absolute URLs so they
  render on PyPI
- Point readers to the full showcase page
@Jalkhov
Jalkhov merged commit 200deaa into stable Nov 15, 2026
10 checks passed
@Jalkhov
Jalkhov deleted the docs/showcase branch November 15, 2026 02:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add screenshots to README

1 participant