Skip to content

Add project logo (README, docs, PyPI) - #7

Merged
zolizoli merged 1 commit into
mainfrom
logo-and-publish
Jul 1, 2026
Merged

Add project logo (README, docs, PyPI)#7
zolizoli merged 1 commit into
mainfrom
logo-and-publish

Conversation

@zolizoli

@zolizoli zolizoli commented Jul 1, 2026

Copy link
Copy Markdown
Member

Adds the project logo across all three surfaces ahead of the first release.

  • docs/assets/logo.png — rendered from imgs/logo.svg (kept as source). Under docs/ so it is committed (the .gitignore blocks *.png except under docs/) and served by mkdocs.
  • README — centered logo header via an absolute raw.githubusercontent.com URL, so it renders on the PyPI page (PyPI blocks SVG and won't resolve relative paths).
  • mkdocstheme.logo + favicon; docs/index.md gains a home hero.

mkdocs build --strict green; the logo is copied into site/assets and referenced by the header, favicon, and home page. Code is untouched.

🤖 Generated with Claude Code

- docs/assets/logo.png: PNG rendered from imgs/logo.svg (kept as source).
  Placed under docs/ so it is committed (the .gitignore blocks *.png except
  under docs/) and served by mkdocs.
- README.md: centered logo header via an absolute raw.githubusercontent URL
  so it renders on the PyPI project page (PyPI blocks SVG and does not
  resolve relative paths).
- mkdocs.yml: set theme.logo and favicon; docs/index.md gains a home hero.

mkdocs build --strict green; logo copied into site/assets and referenced by
the header, favicon, and home page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@zolizoli
zolizoli merged commit 2d96cc3 into main Jul 1, 2026
4 checks passed
@zolizoli
zolizoli deleted the logo-and-publish branch July 1, 2026 09:37
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.

1 participant