Skip to content

mqy/docs

 
 

Repository files navigation

MinIO Docs

Build Instructions

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

Prerequisites

  • Python 3.6.0 or later. MinIO uses the latest stable version of Python for regular writing and development work.

  • 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 python -3 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 html

  5. Run python -m http.server --directory build/BRANCH/html. Open your browser to the output URL 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.

About

MinIO Object Storage Documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 29.9%
  • CSS 28.5%
  • SCSS 23.0%
  • HTML 14.0%
  • JavaScript 2.8%
  • Makefile 1.0%
  • Batchfile 0.8%