Running Documentation Manually
If you'd rather run the documentation site without Docker, you can run it directly with MkDocs.
- Clone the repository with
git clone https://github.com/codethesaurus/docs.git - Switch into the directory with
cd docs - Set up a virtual environment (recommended):
- Windows:
python -m venv venv, then activate withvenv\Scripts\activate - Mac/Linux:
python3 -m venv venv, then activate withsource venv/bin/activate - Install the dependencies with
pip install -r requirements.txt - Start the development server with
mkdocs serve - In your browser, visit http://localhost:8000. As you edit the docs files, the site updates automatically.