Welcome to the Courtgrabber Documentation public repository. These files have been formatted according to the MkDocs theme and are best viewed on an MkDocs site. We have not yet found a permanent hosting service, but we hope to make the move soon. In the meantime, you can view the files by downloading MkDocs, cloning this repo, and running the built-in MkDocs dev server to view the site locally.
Run the following command from your command line to install MkDocs:
pip install mkdocs
If you encounter any issues, refer to the MkDocs Installation Guide for more detailed instructions.
Fork and clone this repo to your local machine. Your project directory should contain the mkdocs.yml configuration file and a docs directory with several Markdown files and an images subdirectory.
From your command line, navigate to your new project directory and then run the following command:
mkdocs serve
With the server running, open http://127.0.0.1:8000/ in your browser to view Courtgrabber's documentation.
To stop the dev server at any time, hit CTRL + C in the terminal window.