Welcome to the technical documentation site built with MkDocs.
To run this MkDocs site locally, ensure you have the following installed:
- Python (version 3.8 or higher): Download Python
- pip: Python package manager (included with Python)
- Git: To clone the repository (Download Git)
Follow these steps to set up and run the documentation site locally:
- Clone the Repository
git clone https://github.com/qaralink-alpha/scraper-db-spec.git
cd scraper-db-spec-
Create a Virtual Environment (recommend)
Create and activate a Python virtual environment to manage dependencies
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate-
Install Dependencies
Install the required Python packages, including mkdocs and mkdocs-material, using the provided requirements.txt.
pip install -r requirements.txt-
To preview the documentation site locally:
Run the MkDocs development server:
mkdocs serve-
Open your browser and navigate to
http://localhost:8000. -
To stop the server, press Ctrl+C in the terminal.
-- TBD
This project is licensed under the [insert license, e.g., MIT License]. See the LICENSE file for details.