Script to fetch a doc's icon from its website

Offen
  • Stimmt etwas nicht?
#2,780 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
32/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
nodejs
Bereich
developer-experience

Rechercherichtung

Start with the PR template and the existing public/icons/docs/<slug>/ layout to see the three files the script must write (16.png, [email protected], SOURCE), then find where npm scripts and the Node tests and type check are configured. The work covers HTML icon-tag discovery, PNG and ICO parsing, and alpha-aware downscaling, so read the draft PR #2781 before writing anything. Done means the script works for the three example sites and the tests pass, but the maintainer has not yet confirmed the approach.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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, [email protected] 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.
Vorherrschende Sprache
Ruby
Sterne
39.6k
Forks
2.7k
Ø Merge
21 Std. 1 Min.
Gemergte PRs (30 T.)
21

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus freeCodeCamp/devdocs

Alle Issues in freeCodeCamp/devdocs

Ähnliche Issues

Weitere Issues zu Ruby

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.