sxyazi / yazi

💥 Blazing fast terminal file manager written in Rust, based on async I/O.
https://yazi-rs.github.io
MIT License
11.43k stars 266 forks source link

Add man page for yazi #1235

Open SamIsTheFBI opened 2 days ago

SamIsTheFBI commented 2 days ago

Please describe the problem you're trying to solve

I am a heavy user of man pages and I recently noticed that yazi does not have it. Also yazi --help doesn't provide as much help. So, I'd like to contribute to prepare man page that will list out quick reference to all the preset commands, configuration files and more.

Would you be willing to contribute this feature?

Describe the solution you'd like

I'd like to make the man page with troff syntax. I can make use of docs already present in the website for the content.

Additional context

I have made one locally and will write the rest soon.

image
a little preview
sxyazi commented 1 day ago

Awesome work, thank you!

SamIsTheFBI commented 1 day ago

Glad you like it so far! I'll work on the rest of the man page now. Can you please guide me where to put it in the repository?

sxyazi commented 1 day ago

Hi, I created a new repo for it: https://github.com/yazi-rs/manpages