zsh-users/zsh-syntax-highlighting

docs += distro logos?

Open

#902 ouverte le 11 nov. 2022

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Shell (1 371 forks)batch import
IdeaImprovementTaskcomponent:docsgood first issue

Métriques du dépôt

Stars
 (22 617 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Consider adding the logos of each OS, distro, and plugin manager we're packaged in to the documentation (INSTALL.md, perhaps also the landing page README.md).

Compare the use of distro/OS logos in https://subversion.apache.org/packages.

Need to think how to do this without breaking the markdown's usability in source (as opposed to rendered) form.

Split from https://github.com/zsh-users/zsh-syntax-highlighting/pull/877#issuecomment-1173675765

Guide contributeur

Direction de recherche
Étudiez comment intégrer les logos des distributions dans INSTALL.md et README.md sans nuire à la lisibilité du code source markdown. Consultez le commentaire de la PR #877 liée (https://github.com/zsh users/zsh syntax highlighting/pull/877#issuecomment 1173675765) pour le contexte, et la page des paquets d'Apache Subversion (https://subversion.apache.org/packages) comme exemple. Envisagez d'utiliser du texte alternatif et des URL d'images hébergées pour garder le markdown propre.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Markdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90