add some syntax highlighting to the command documentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 40.5k
- Forks
- 2.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 85
Description
Related problem
i'm writing a lot of custom commands and i feel the help pages lack some colors => i always get a block of default-colored text, which is not easy to read, even when the documentation or the examples are helpful 🤔
Describe the solution you'd like
either in the rust source or in the standard library, i think we could add some highlighting to the output of help for the doc of custom commands.
i'd support using markdown syntax, as rust does.
Describe alternatives you've considered
No response
Additional context and details
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Rust source or standard-library path that renders help output for custom-command documentation. Compare the current plain-text output with the requested Markdown-based highlighting and clarify where the behavior should live; done means custom command help is rendered with readable syntax highlighting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, rust
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100