Skip to content

Open the README with a banner of what the tool does - #128

Merged
muellerei merged 1 commit into
mainfrom
docs/readme-banner
Oct 13, 2026
Merged

muellerei merged 1 commit into
mainfrom
docs/readme-banner

Conversation

@muellerei

Copy link
Copy Markdown
Owner

Closes #127.

Summary

 README.md
+<picture>                          # dark or light, by the reader's theme
+  banner-dark.svg / banner-light.svg
 # logseq-cli
 docs/
+├── src/banner.py                  # writes both banners from one colour table
+└── images/
+    ├── banner-light.svg
+    ├── banner-dark.svg
+    ├── social-preview.svg         # --social
+    └── social-preview.png         # rendered from it, 1280x640

Evidence

  • Before: the README starts with the title and the badges.
    After: the banner sits above the title. Running python3 docs/src/banner.py <dir> and python3 docs/src/banner.py <dir> --social again writes files identical to the committed ones (cmp). ruff check . passes, scripts/check-links.py reports 0 broken links, and the suite passes (4046 passed, 8 skipped).

Merge Danger

Door: two-way

Blast Radius: cosmetic

Only the README and new files under docs/ change; no code in the package.

The banner shows an agent's write landing in a Logseq page and another one
refused because the block is open in the editor. docs/src/banner.py writes
the light and the dark SVG from one set of colours, so the two cannot drift,
and GitHub shows the one that matches the reader's theme. With --social it
writes the picture behind docs/images/social-preview.png, the repository's
social preview, rendered from it at 1280x640.
@muellerei
muellerei merged commit eb78d3a into main Oct 13, 2026
6 checks passed
@muellerei
muellerei deleted the docs/readme-banner branch October 13, 2026 13:52
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.

The README opens with a picture of what logseq-cli does

1 participant