Files
mkdocs-quickstart/docs/tutorial/installation.md
Michael Currin 5e8b217c8d docs: Update docs
2020-10-17 16:23:20 +02:00

60 lines
1.1 KiB
Markdown

# Installation
> How to install MkDocs locally.
## Requirements
- [Python 3](https://www.python.org/)
## Install system dependencies
<script src="https://gist.github.com/MichaelCurrin/57caae30bd7b0991098e9804a9494c23.js"></script>
## Setup repo
Choose or setup a MkDocs project.
- Follow the tutorial page to setup a project.
- Or click _Use this template_ on this repo to create your own copy of the repo, then clone it.
## Install project dependencies
> Install MkDocs locally
For more info, see the [Installation](https://www.mkdocs.org/#installation) page on the MkDocs site.
### Use a virtual environment
Create a virtual environment at the project root.
```sh
$ python3 -m venv venv
```
Activate it.
```sh
$ source venv/bin/activate
```
Install `mkdocs` from project dependencies list.
```sh
$ pip install -r requirements.txt
```
### Install globally
If you prefer to install MkDocs once and reuse it across projects, then you can install it globally.
MkDocs is available using package managers like `apt-get`, `homebrew` and `yum`.
You can install like this too:
```sh
python3 -m pip install mkdocs
```