MinIO Docs

Build Instructions

MinIO uses Sphinx to generate
static HTML pages using ReSTructured Text.

Prerequisites

• Python 3.10.X.

• NodeJS 14.5.0 or later.

• git or a git-compatible client.

• Access to https://github.com/minio/docs

All instructions below are intended for Linux systems. Windows builds may work
using the following instructions as general guidance.

Build Process

1. Run git checkout https://github.com/minio/docs and cd docs to move into
   the working directory.

2. Create a new virtual environment python3 -m venv venv. Activate it using
   source venv/bin/activate.

3. Run pip install -r requirements.txt to setup the Python environment.

4. Run make stage

5. Open your browser to http://localhost:8000 to view the staged output.

This project is licensed under a Creative Commons Attribution 4.0 International License.

See CONTRIBUTIONS for more information on contributing content to the MinIO Documentation project.