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

Documentation of output colors and styles #261

Closed
alekratz opened this issue Aug 8, 2017 · 4 comments
Closed

Documentation of output colors and styles #261

alekratz opened this issue Aug 8, 2017 · 4 comments

Comments

@alekratz
Copy link

alekratz commented Aug 8, 2017

I love exa! One new feature I noticed is that, in project directories, Cargo.toml and README/README.md are being highlighted yellow with an underline. I'm not entirely sure what this means; it would be awesome if the manpage could be updated with an explanation of what all of the colors and text styles indicate.

@stumpylog
Copy link

I agree that this information would be helpful to have documented. I think from reading the source in https://github.com/ogham/exa/blob/master/src/output/colours.rs, this documentation could be derived. Except I'm not sure a) where documentation should go and b) what some of the file types are.

For example, the Cargo.toml seems likely to map to the immediate: Yellow.bold().underline() style, but what is that file type?

@hoodie
Copy link
Contributor

hoodie commented Aug 24, 2017

perhaps exa could even print a color chart of some sort, that should be relatively easy to do. Something like exa --help-colors that just prints each color and what it means. That also allows you to see the colors in context, since some terminals temper with the colors.

@ogham
Copy link
Owner

ogham commented Sep 30, 2017

I've added some documentation to the man page that says what the colours mean, how to customise them, and how to turn them off.

@vii33
Copy link

vii33 commented Dec 23, 2022

I took @ogham 's notes and put them into a proper markdown format: https://github.com/ogham/exa/blob/c1c88dbbf30da4fbf7b3c98fe8cd545961edda60/man/exa-colors-explanation.md

Hopefully this helps.

Great peace of software by the way 👍

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

No branches or pull requests

5 participants