zsh-users/zsh-syntax-highlighting

Should be noted in the documentation about sourcing when using brew

Open

#613 opened on May 13, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Shell (22,617 stars) (1,371 forks)batch import
TaskUpstreamcomponent:docsgood first issueresolution:if-and-when-needed

Description

When you use homebrew there is a specific source path you need to use in .zshrc in order for it to work. This is non-obvious and can be easily missed in the homebrew printout after the install. This should be noted to make the install documentation better

Contributor guide

Tech stack
shell
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.
under 1 hour
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.
clear
Prerequisites
Homebrewbasic Zsh configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue requests adding documentation about the specific source path needed after installing via Homebrew. The fix likely involves editing the README.md to include a note under the Homebrew installation instructions, specifying the path (e.g., 'source /usr/local/share/zsh syntax highlighting/zsh syntax highlighting.zsh') or directing users to the output of the brew install command. The maintainer should verify the correct path and add a clear example.
Should be noted in the documentation about sourcing when using brew · zsh-users/zsh-syntax-highlighting#613 | Good First Issue