Skip to content

Script to fetch a doc's icon from its website #2780

Open

Description

@buggypather

Feature request

Summary

A small script that fetches a doc's icon from the documented project's website and saves it the way DevDocs expects:

npm run icon -- <doc_slug> <website>

It writes public/icons/docs/<slug>/16.png, 16@2x.png and SOURCE, the three files the PR template asks for.

Today, each new doc's icon is found, resized to 16 and 32 pixels and saved by hand. The script does that step for contributors and keeps the SOURCE file accurate. It also helps when updating a doc whose icon has changed.

How it works:

  • It looks for the icon in the page's <link rel="icon"> and <link rel="apple-touch-icon"> tags, trying the smallest one that is at least 32 pixels first. If none works, it tries /apple-touch-icon.png and /favicon.ico.
  • It reads PNG files and ICO files, including ICO files that contain bitmaps rather than PNGs.
  • It scales the icon by averaging pixels with premultiplied alpha, so 16-pixel icons stay crisp and transparent edges don't darken.
  • It uses only Node's standard library, so there are no new dependencies. It sits beside the existing Node tests and type check.
  • SVG-only icons can't be converted without a dependency, so the script says so. --icon <image address> then uses a specific PNG or ICO instead.

Contributors should still check the result at 16 pixels, as they do today. The script only automates finding, resizing and recording the source.

I've prepared an implementation with tests in draft PR #2781. Would you be open to this? I'm happy to change the approach, for example to a thor task.

Examples

Tried on real sites:

  • npm run icon -- python https://www.python.org saves the icon from /static/apple-touch-icon-precomposed.png.
  • npm run icon -- github https://docs.github.com saves the icon from /assets/cb-345/images/site/favicon.png.
  • npm run icon -- vue https://vuejs.org explains that the site only offers logo.svg, and suggests --icon.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions