eza-community / eza

A modern alternative to ls
https://eza.rocks
European Union Public License 1.2
11.41k stars 205 forks source link

docs(readme) command line options section: add link to man pages + fix structure #968

Closed CouldBeThis closed 4 months ago

CouldBeThis commented 4 months ago
Description

<!--- Describe your changes in detail -->

  1. Added link to the man pages in repo readme
  2. Inserted a couple keywords typically associated with instructions
  3. Also while I was there:
    • Fixed the heading hierarchy
    • Removed the entire "Command-line options" section from being in a <details> collapsible section. Instead made the content of the 3 subheadings collapsed which I infer from the wording was the original intention.

<!--- Why is this change required? What problem does it solve? -->

  1. man pages are easy to miss and not widely available elsewhere
  2. keywords ("quick", "overview", "documentation") that I thought would help someone find the instructional section using ctrl-f. Since content is still mostly collapsed it isn't visible when you quickly scroll the page.
  3. The whole section being collapsed makes it difficult to notice the useage information. It breaks the anchor-based navigation and the popup menu on github.com.

Hope it's OK to have added 2 and 3 at the same time; seems kind of minor to open an independent issue for. I tried to make the commits structured so they are independent in case it's unwanted.

<!--- If it fixes an open issue, please link to the issue here. -->

967

How Has This Been Tested?

I did not test this other than looking at it. I hope it's OK. If not, please discard this PR because I probably won't be able to set up a whole dev environment. If you wish to make use of the content somehow please do so in whatever fashion if most expedient.