Skip to content

Instantly share code, notes, and snippets.

@ElectronicsArchiver
Created December 6, 2022 13:22
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ElectronicsArchiver/4631c95461fd9352e6ba819b997902a6 to your computer and use it in GitHub Desktop.
Save ElectronicsArchiver/4631c95461fd9352e6ba819b997902a6 to your computer and use it in GitHub Desktop.

I'm not gonna make this that nice though, too much work..


Repository

  • Disable unused tab 'Projects'

  • Add more tags for SEO

  • Update description:

    '🏞  Fast image zooming on click'

    1. Keep it simple ( content wise )
    2. Uses two 4/EM spaces to simulate the gap in the below linked website, which also just spaces it nicely
  • Separate preview page code from library



Content

I would ..

  • place the page title at the top ( if there is no banner), so that it is directly visible when you visit the page

  • Nice gif for demonstration, since the content doesn't matter, but the action presented, I would make it half the page size and place it next to the 'why is it better' section

  • use buttons for the links ( Demo ,.. )

  • stylize the badges and place them at the top.

  • center the title & short description.

  • add additional spacing in between each 'why is it better' icon and text.

  • move the detailed comparison description into a separete place that only focuses on that so that this overview only gives a basic impression.

  • add vertical spacing everywhere, between paragraphs, ..

  • stylize headlines / simplify them ( Basic usage -> usage -> Usage )

  • move npm / yarn into installation section

  • differentiate import / cdn sections with subheadlines ( Imported , CDN ) with italic descriptions for the people that want more context.

  • Plugin targets meaningful, content images: ??

    Not quite sure why that is in a section named How it works

  • spread out config section, one headline for one config option

  • add custom spacing ( 2 x 4/EM spacing instead of normal space ) between letters and blocks

  • Separate content into dedicated files so users don't have to scroll through unrelated stuff



Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment