- Visit https://hueyyeng.github.io/VesperiaGuide/ for the checklist guide.
- Clone and build/serve this repo.
- Python 3.6+ (last tested with Python 3.8.10)
# Clone project using https
git clone https://github.com/hueyyeng/VesperiaGuide.git
It is recommended to install the project's dependencies into a virtual env.
Read more about Virtualenv over here: https://realpython.com/python-virtual-environments-a-primer/
# Go into the project directory
cd VesperiaGuide
# Create a new virtualenv in a directory named 'env'
python -m venv env
# Activate the virtualenv
source env/bin/activate
# Install Python dependencies
pip install -r requirements.txt
# Go into the project directory
cd VesperiaGuide
# Create a new virtualenv in a directory named 'env'
python -m venv env
# Activate the virtualenv
source env/Scripts/activate
# Install Python dependencies
pip install -r requirements.txt
- Make sure the current working directory has
mkdocs.yml
and docs directory.
# Generate the guide and serve on localhost
mkdocs serve