Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add syntax highlighting to examples in ockam command help. #3311

Closed
mrinalwadhwa opened this issue Aug 24, 2022 · 1 comment
Closed

Add syntax highlighting to examples in ockam command help. #3311

mrinalwadhwa opened this issue Aug 24, 2022 · 1 comment

Comments

@mrinalwadhwa
Copy link
Member

mrinalwadhwa commented Aug 24, 2022

Currently

In the help for various ockam command we're adding examples.

For example ockam

Screen Shot 2022-08-24 at 7 49 59 AM

Also try:

ockam secure-channel create --help

Desired

The examples section, which is usually made of shell commands, we want to make it have colors.
Syntect seems like a good crate to use for this, but there may be others
https://crates.io/crates/syntect

The code for the above example is here https://github.com/build-trust/ockam/blob/develop/implementations/rust/ockam/ockam_command/src/lib.rs#L64-L77


We love helping new contributors!
If you have questions or need help as you work on your first Ockam contribution, please leave a comment on this discussion.
If you're looking for other issues to contribute to, checkout this discussion and labels - good first issue or help wanted

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant