github-insights / github-metrics

0 stars 0 forks source link

Create project documentation using GitHub Pages #150

Open tomellm opened 6 months ago

tomellm commented 6 months ago

Repository where to document the project: https://github.com/github-insights/github-insights.github.io

We'll use GitHub Pages to host the free publicly available documentation: https://pages.github.com

Consider using Material for MkDocs to build a clean documentation website with support for local search, ... https://squidfunk.github.io/mkdocs-material

I expect at least a getting started guide. How to start the Docker container, what configurations are there ... ?