69 lines (44 loc) · 1.69 KB

Web3 Pi Documentation

How to Run the Project

Prerequisites

Ensure you have Python 3.11 or newer installed on your system.
Make sure you have pip installed to manage Python packages.

Steps to Run the Project

Clone the Repository

Clone the repository to your local system using the command below:
```
git clone git@github.com:Web3-Pi/docs.git
```
Navigate to the Project Directory

Switch to the project's root directory:
```
cd docs
```
Create and Activate a Virtual Environment

It is recommended to use a virtual environment to isolate the project dependencies. Use the following commands to create and activate the virtual environment:
```
python -m venv .venv
source .venv/bin/activate  # On Linux/macOS
.venv\Scripts\activate     # On Windows
```
Install Dependencies

Install the required Python dependencies:
```
pip install -r requirements.txt
```
Build the Documentation

To build and serve the documentation locally, run the following command:
```
mkdocs serve
```
This will start a local development server and you will be able to access the documentation at:
```
http://127.0.0.1:8000/
```
Check the Deployed Documentation

You can also view the deployed documentation online at https://docs.web3pi.io/.

Additional Notes

This project uses the Material for MkDocs theme, which is defined in the mkdocs.yml configuration file.
Ensure the directories and assets (such as extra_css, extra_javascript, and logo images) defined in mkdocs.yml are accessible when building the project.