To run this documentation site on your local machine, you will need to have the following software installed:
- Python 3
- pip
-
Clone the repository to your local machine.
-
Navigate to the root directory of the repository in your command prompt or terminal.
-
Install the required packages by running the following command:
pip install -r requirements.txt
This will install MkDocs and any necessary dependencies.
-
Once the installation is complete, you can start a local server to view the documentation by running the following command:
mkdocs serve
This will start a local server that you can access in your web browser at
http://localhost:8000
. -
Make any necessary changes to the documentation files in the
docs
directory, and the changes will be automatically reflected in your local server.
That's it! Now you can view and edit the documentation for our project on your local machine. If you have any questions or issues, please don't hesitate to reach out to us. Happy documenting!