search

Textualize / rich

Rich is a Python library for rich text and beautiful formatting in the terminal.
https://rich.readthedocs.io/en/latest/
MIT License
49.65k stars 1.73k forks source link

[REQUEST] Could you please add images to the rich docs? #3547

Closed misrasaurabh1 closed 2 weeks ago

misrasaurabh1 commented 3 weeks ago

How would you improve Rich?

I am a new user to rich. I am a fan, it has improved codeflash.ai 's look and feel quite a lot.

One problem I have is that from the official docs, i don't really understand what a particular feature will do just from looking at the docs. Since rich is such a visual library, adding images to all the examples will greatly help developers understand and value rich.

What problem does it solve for you?

I don't understand what feature could be useful to me, because i don't know what the feature looks like. It limits new user and existing user adoption.

github-actions[bot] commented 3 weeks ago

Thank you for your issue. Give us a little time to review it.

PS. You might want to check the FAQ if you haven't done so already.

This is an automated reply, generated by FAQtory

willmcgugan commented 3 weeks ago

What would you like to see images of?

misrasaurabh1 commented 2 weeks ago

What would you like to see images of?

I would like to see "if i implemented the code example mentioned in the docs, then how would the resulting output look like.". Without this context I have a hard time understanding what a particular feature means in the doc.

willmcgugan commented 2 weeks ago

There are numerous examples of output in the docs, as html. I'm sure there could be more, but frankly you can see the output of most things by copying a few lines in to your terminal.

If you would like to PR for screenshots in the docs, feel free, but this is very low priority considering you are the first to ask.

github-actions[bot] commented 2 weeks ago

I hope we solved your problem.

If you like using Rich, you might also enjoy Textual