Please Note: When a commit is pushed to the
docs/
directory, it triggers a github actions workflow to build the static-site and push it to the gh-pages branch.
# Clone the Repository
git clone https://github.com/OpenOmics/mpox-seek.git
cd mpox-seek/
# Create a virtual environment
python3 -m venv .venv
# Activate the virtual environment
. .venv/bin/activate
# Update pip
pip install --upgrade pip
# Download Dependencies
pip install -r docs/requirements.txt
MkDocs includes a previewing server, so you can view your updates live and as you write your documentation. The server will automatically rebuild the site upon editing and saving a file.
# Activate the virtual environment
. .venv/bin/activate
# Start serving your documentation
mkdocs serve
Once you are content with your changes, you can build the static site:
mkdocs build