Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Polygon Edge docs

Welcome to the Polygon Edge documentation, built with the Material theme for MkDocs.

Build and serve the site

Clone the repo

https://github.com/0xPolygon/polygon-edge.git
cd polygon-edge/docs

Run with Python

  1. Download and install Python 3.11: https://www.python.org/downloads/

  2. Install the virtualenv package:

pip install virtualenv
  1. Build and serve the html
./run.sh

The site runs at: http://127.0.0.1:8000/

Run with Docker

⚠️ Remove line 10 from the Dockerfile to run locally.

  1. Spin up the image:
docker build -t polygon-edge-docs .
  1. Run the container:
docker compose up

The site runs at: http://127.0.0.1:8000/