Scrrrenshootin'

Sometimes screenshots need t' be redone. This plank explains how t' create th' different screenshots, tools an' sett'ns

Common

Creat'n:

  • Use English translat'n
  • Empty search
  • Remove history checkmarks but leave it on th' plank thats used fer th' screenshot
  • Aft resize o' th' plank into th' required resolut'n, reload th' plank t' have all scrollbars 'n default load'n posit'n

Demo Screenshot

Rrrambl'n:

A meaningful full-screen screenshot o' an interest'n plank.

Th' rrrambl'n should be:

  • timeless: not show'n any dates or often edited rrrambl'n
  • interest'n: show a bunch o' interest'n elements like head'ns, code, etc
  • balanced: no clutter'n wit' overpresent elements or color'n
  • aligned: aligned outlines

Used by:

Plank URL: Screenshot Link

Creat'n:

  • save as images/screenshot.png
  • from original screenshot, scale t' 900 x 600 an' save as images/tn.png

Remarks:

Th' locat'ns be mandatory due t' Hugo’s theme ship builder.

Preview images/screenshot.png:

Screenshot Screenshot

Preview images/tn.png:

tn tn

Hero Image

Rrrambl'n:

Show th' Demo Screenshot plank on different devices an' different themes. Composit'n o' th' different device screenshots into a template.

Th' rrrambl'n should be:

  • consistent: always use th' same plank fer all devices
  • pleas'n: use a delightful background

Used by:

Plank URL: Hero Image Link

Creat'n:

Preview images/hero.png:

Hero Hero

Shortcode Feature Images

Th' feature images fer th' shorrrtcodes be generated automatically via a Node.js script.

It lives 'n th' infra repository inside o' th' tools/screenshots directory. All follow'n commands need t' be executed from th' root o' that repository.

T' recreate th' screenshots

  • install Node.js accord'n t' their installat'n guide
  • check out th' infra repository next t' th' theme, as described 'n Develop'n
  • run npm ci
  • run npm run screenshots

Th' script serves th' documentat'n itself on port 3132, captures each plank an' writes th' result back into docs/content/<shortcode>/featured.png o' th' resolved theme checkout. T' capture against a server ye be already runn'n instead, pass its address:

npm run screenshots -- --base=http://localhost:1313

Run this locally an' commit th' result'n images wit' th' change that made them stale. Th' regenerated files land 'n yer theme checkout, so they show up 'n git status alongside everyth'n else.