11ty / 11ty/docs

feat: Add automated screenshots for starter projects

Open
#223 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Nunjucks
Stars
547
Forks
726
Avg merge
2h 23m
Merged PRs (30d)
3

Description

hi @zachleat @gerwitz and team,

First off, keep up the amazing work and looking forward to v1!

This is a proposal. What do you folks feel if the list of starter projects had automatically generated screenshots per entry.

I was thinking of using puppeteer (headless Chrome driver) to generate screenshots for the demo sites at build time. Pictures really add a lot of value e.g. Hugo Theme Gallery.

I have a working prototype but wanted to gather thoughts before going too far: PR, Demo.

Screen Shot 2019-10-27 at 8 57 00 AM

I am no CSS expert - so I am totally open to styling and other presentation tweaks.

Eventually this idea can also be extended to Source Code Samples.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the starter projects documentation at /docs/starter/ and review the linked prototype pull request and demo. Clarify whether build-time Puppeteer screenshots are wanted, how they should be presented, and how the generated entries will be maintained. Done should mean the agreed screenshot workflow is implemented for the starter project list.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.