Skip to content

Add screenshots to the example readme files#20

Open
trymnilsen wants to merge 1 commit into
varabyte:mainfrom
trymnilsen:main
Open

Add screenshots to the example readme files#20
trymnilsen wants to merge 1 commit into
varabyte:mainfrom
trymnilsen:main

Conversation

@trymnilsen

Copy link
Copy Markdown

Makes it easier for people browsing the repo to see a visual version of the examples without needing to download and run them

@bitspittle

bitspittle commented Jun 13, 2026

Copy link
Copy Markdown
Member

I'mHello! We intentionally do not include media files in templates to keep this repo really really lean (since every time someone runs kobweb create it does a clone).

Can you explain more what you mean when you said

Makes it easier for people browsing the repo to see a visual version of the examples without needing to download and run them

because my understand is the way people choose to download the repo in the first place is by reading the description in the kobweb create list. I think it's pretty rare people go to the template project directly on GitHub?

One thing that I'm thinking about in the future is improving Kotter (my CLI library) to allow images if the terminal supports it. Maybe that would be a good place to show a preview image, so you can see it when browsing the template list there. But that's not going to be able to happen for a while.

Finally: I do have https://github.com/varabyte/media, you are welcome to open a PR against that one to upload the screenshots there. Just look at the existing directory structure and try to create a good place for Kobweb template screenshots? I don't really have strong feelings against putting them in there. And then you can reference those screenshots from the template READMEs

@trymnilsen

Copy link
Copy Markdown
Author

Ah thanks, did think about the kobweb create part.
When I researched kobweb for a project, I immediately went looking for examples by old habbit. Then having to clone and, setup and run to see anything visual was friction. Friction I was thinking I could contribute to reducing. Happy to put them somewhere else that is more efficient ☺️

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.

2 participants