zsh-users/zsh-syntax-highlighting

docs += distro logos?

Open

#902 opened on Nov 11, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Shell (22,617 stars) (1,371 forks)batch import
IdeaImprovementTaskcomponent:docsgood first issue

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

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic markdownGitHub markdown image syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Investigate how to embed distro logos in INSTALL.md and README.md without breaking markdown source readability. Look at the linked PR #877 comment (https://github.com/zsh users/zsh syntax highlighting/pull/877#issuecomment 1173675765) for context, and the Apache Subversion packages page (https://subversion.apache.org/packages) as an example. Consider using alternative text and hosted image URLs to keep markdown clean.