zsh-users/zsh-syntax-highlighting

docs += distro logos?

Open

#902 创建于 2022年11月11日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Shell (22,617 star) (1,371 fork)batch import
IdeaImprovementTaskcomponent:docsgood first issue

描述

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

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
basic markdownGitHub markdown image syntax
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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.