Skip to content

guides-show: example guide screenshot on the landing page #1336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
backnotprop merged 1 commit into from
Aug 17, 2026
Merged

guides-show: example guide screenshot on the landing page #1336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions apps/guides-show/site/_headers
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
Cache-Control: public, max-age=300
/banner.webp
Cache-Control: public, max-age=86400
/example_guide.webp
Cache-Control: public, max-age=86400
Binary file added apps/guides-show/site/example_guide.webp
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion apps/guides-show/site/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@
.cmd button:hover{color:var(--heading);border-color:var(--muted)}
.cmd button:focus-visible{outline:1px solid var(--add);outline-offset:2px}
.cmd button.done{color:var(--add);border-color:var(--add)}
.banner{display:block;width:100%;height:auto;margin:1.5rem 0 0;border:1px solid var(--border);border-radius:8px}
.banner,.shot{display:block;width:100%;height:auto;margin:1.5rem 0 0;border:1px solid var(--border);border-radius:8px}
.shot{margin-top:1rem}
footer{margin-top:4rem;padding-top:1.25rem;border-top:1px solid var(--border);color:var(--muted);font-size:.85rem;display:flex;flex-wrap:wrap;gap:.4rem 1.25rem}
footer a{color:var(--text)}
@media (prefers-reduced-motion:no-preference){a{transition:text-decoration-color .15s}}
Expand Down Expand Up @@ -126,6 +127,10 @@ <h2>Share links</h2>
<h2>This host</h2>
<p>Viewer builds live under <code>/v1/</code> and never change once published, so a guide from last year opens the same way. A downloaded file sends nothing about your code here. It is a small Cloudflare Worker (<a href="https://github.com/backnotprop/plannotator/tree/main/apps/guides-show"><code>apps/guides-show</code></a>) you can run yourself.</p>

<h2>What one looks like</h2>
<p>A two-chapter guide, opened in a browser. Chapter on the left, its files on the right.</p>
<img class="shot" src="/example_guide.webp" alt="A guide with two chapters. Left: the chapter title, a short overview, and the files it covers. Right: the diff for each file." width="1774" height="1101" loading="lazy" decoding="async">

<footer>
<a href="https://plannotator.ai/docs/reference/portable-guides/">File format</a>
<a href="https://github.com/backnotprop/plannotator">Plannotator</a>
Expand Down