ci-benchmarks

A Polymath-style benchmark site built with MkDocs and deployable on GitHub Pages.

Prerequisites

• Python ≥ 3.7
• Git
• A GitHub account with a repo named ci-benchmarks under your username or organization.

Local Setup & Preview

1. Clone the repo

   git clone https://github.com/Echo-Node/ci-benchmarks.git
   cd ci-benchmarks

2. Create & activate a virtual environment

   python3 -m venv .venv
   source .venv/bin/activate

3. Install dependencies

   pip install mkdocs-material pymdown-extensions

4. Serve locally

   mkdocs serve

Deploy to GitHub Pages

1. Commit any changes

   git add .
   git commit -m "Ready for deploy"

2. Deploy with MkDocs

   mkdocs gh-deploy

   If you get a non-fast-forward error, force an overwrite with:

   mkdocs gh-deploy --force