Skip to content

Installation

Install all required dependencies for the MkDocs Material documentation system.

Prerequisites

  • Python 3.8 or higher
  • pip package manager

Installation Steps

1. Install MkDocs Material

Bash
pip install mkdocs-material

2. Install All Plugins

Bash
pip install \
    mkdocs-mermaid2-plugin \
    mkdocstrings[python] \
    mkdocs-awesome-nav \
    mkdocs-section-index \
    pymdown-extensions \
    mkdocs-swagger-ui-tag \
    mkdocs-jupyter \
    mkdocs-macros-plugin

3. Generate Configuration

Bash
python3 mkdocsgen.py --name "Docs" docs/

4. Verify Installation

Bash
mkdocs --version
mkdocs serve

Next Steps

Proceed to configuration to customize your setup.