zsh-users/zsh-syntax-highlighting

docs: Deduplicate ZSH_HIGHLIGHT_STYLES values documentation

Open

#236 建立於 2015年11月24日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Shell (22,617 star) (1,371 fork)batch import
Taskcomponent:docsgood first issueresolution:if-and-when-needed

描述

As ded1c8789b07155c833fc49abbb422b93233e81c + 7ee350efcd125c7b6595bf5f59b55c74eae01ad4 show, a bit of the highlighters documentation is duplicated a number of times. Deduplicate it, either by restructuring the docs (to add interlinking) or by using some sort of #include-like facility.

Reminder: the consumers for docs are:

  • Users browsing the homepage (which is just the github repository renderer),
  • Users running from a git worktree,
  • Users running from a make installed tree.

貢獻者指南

技術棧
shell
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
read docs folderunderstand ZSH HIGHLIGHT STYLESknowledge of Markdownbasic shell scripting
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
Look at the commit references (ded1c8789b07155c833fc49abbb422b93233e81c and 7ee350efcd125c7b6595bf5f59b55c74eae01ad4) to see the duplicated documentation. The repo uses a docs/ directory. Consider restructuring the highlighters documentation to reduce duplication, possibly by using include mechanisms or interlinking. Ensure the solution works for both GitHub rendering and local installed trees.