Github-Readme-Stats Documentation

About this Project

Github-Readme-Stats Documentation, or GRS-Docs for short, is a documentation site for project Github-Readme-Stats. Tht site itself is built with mkdocs-material and hosted on Github Pages.

Here you can help GRS with documentation, for now translation capabilities are not avaliable but they will be added in the future.

Check out the Site!

Build

Locally

Please check the documentation of mkdocs-material.

https://squidfunk.github.io/mkdocs-material/creating-your-site/#previewing-as-you-write)https://squidfunk.github.io/mkdocs-material/creating-your-site/#previewing-as-you-write

Github Actions

• 1. Fork this repository
• 2. Enable Actions workflow
• 3. Commit changes
• 4. Preview it with the Github Pages URL. (If you did not change the fork's repo name, then the link is https://{YOUR-GITHUB_USERNAME}.github.io/grs-docs