# Installation

> How to install MkDocs locally.

## Requirements

- Python 3
- Make - standard on macOS and Linux but can be installed on Windows too.

## Install system dependencies

## Set up a new repo

Follow the Tutorial page to set up a project from scratch.

Or click this create your own copy of the repo.

Then clone your repo.

e.g.

    $ git clone git@github.com:MichaelCurrin/mkdocs-quickstart.git
    $ cd mkdocs-quickstart

## Install project dependencies

> Install MkDocs locally

For more info, see the Installation page on the MkDocs site.

### Install in a virtual environment

Create a virtual environment at the project root - this is used to isolate project packages from the global packages.

    $ python3 -m venv venv

Activate the environment.

    $ source venv/bin/activate

Install `mkdocs` - this is covered in the project requirements file.

    $ cd docs
    $ make install

Note - `mkdocs` 1.2 causes a break on force pushes, so this is excluded in the requirements. See issue #2447.

### Install globally

If you prefer to install MkDocs once and reuse it across projects, then you can install it globally instead.

MkDocs is available using package managers like `apt-get`, `homebrew` and `yum`.

Or you can install like this:

    $ python3 -m pip install mkdocs

If you get prompted for `sudo` use, then cancel and run again with `-U` flag for user-level install.

GitHub « Previous Next »