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.