Reorganize docs in readme

[mezzode]

Resolves #2236. Moves options docs into the sections for the cards they're for and streamlines readme so detailed examples are collapsed by default.

[vercel[bot]]

@mezzode is attempting to deploy a commit to the github readme stats Team on Vercel.

A member of the Team first needs to authorize it.

[rickstaa]

@mezzode Thanks a lot for this pull request it improves the README.md. The only thing that I would change is to keep the themes section. I think if we collapse the theme section by default, we will get many discussion posts from people on how to customize the themes. Further, maybe we can use the 👀 icon before show examples. I do this in the rest of the documentation since many people are unaware of the collapsable markdown option introduced somewhere last year, and 👀 draws their attention. Nevertheless, I already attached the hacktoberfest-accepted label so take your time. 👍🏻

[codecov[bot]]

Codecov Report

Base: 96.79% // Head: 96.79% // Decreases project coverage by -0.01% :warning:

Coverage data is based on head (12317f3) compared to base (0efb982). Patch has no changes to coverable lines.

:exclamation: Current head 12317f3 differs from pull request most recent head 7d612e7. Consider uploading reports for the commit 7d612e7 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2242      +/-   ##
==========================================
- Coverage   96.79%   96.79%   -0.01%     
==========================================
  Files          22       22              
  Lines        3836     3835       -1     
  Branches      328      328              
==========================================
- Hits         3713     3712       -1     
  Misses        121      121              
  Partials        2        2              

Impacted Files	Coverage Δ
src/cards/stats-card.js	100.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

[rickstaa]

@anuraghazra I think this is a significant improvement of the documentation. 🚀 Can we please merge this?

[anuraghazra]

Amazing restructure @mezzode! Thanks for the PR.

Although now I wonder what will happen to the translated docs 😆 TBH I find them hard to maintain and doesn't add much value to the overall project other than welcoming new people to contribute to the translation docs.

[rickstaa]

Amazing restructure @mezzode! Thanks for the PR.

Although now I wonder what will happen to the translated docs 😆 TBH I find them hard to maintain and doesn't add much value to the overall project other than welcoming new people to contribute to the translation docs.

I gave up on the non-card-related translations a long time ago since I got overwhelmed by maintaining them 😅 (I'm not a polyglot). I was still hoping to put the card translations into Crowdin and write a small github action that uses the Google translation API to translate the README using the Google translate API👌(see https://github.com/anuraghazra/github-readme-stats/issues/2053). Maybe there are already existing solutions that do this, or Crowdin got updated to be able to do this automatically. 🤔