From 6f2b3c818e28f4e0e3127217b9a65181200e99d1 Mon Sep 17 00:00:00 2001 From: Michael Currin <18750745+MichaelCurrin@users.noreply.github.com> Date: Fri, 18 Dec 2020 12:22:56 +0200 Subject: [PATCH] Update installation.md --- docs/docs/tutorial/installation.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/docs/tutorial/installation.md b/docs/docs/tutorial/installation.md index 29164ae..534384a 100644 --- a/docs/docs/tutorial/installation.md +++ b/docs/docs/tutorial/installation.md @@ -12,18 +12,15 @@ -## Setup repo +## Setup a new repo -Choose or setup a MkDocs project. +Follow the Tutorial page to setup a project from scratch. - -Follow the tutorial page to setup a project. - -Or click the button on this repo to create your own copy of the repo. +Or click this create your own copy of the repo. [![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f?style=for-the-badge&logo=github)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate) -Then clone it. +Then clone your repo. e.g. @@ -40,34 +37,36 @@ For more info, see the [Installation](https://www.mkdocs.org/#installation) page ### Use a virtual environment -Create a virtual environment at the project root. +Create a virtual environment at the project root - this is used to isolate project packages from the global packages. ```sh $ python3 -m venv venv ``` -Activate it. +Activate the environment. ```sh $ source venv/bin/activate ``` -Install `mkdocs` from the project dependencies list. +Install `mkdocs` - this is covered in the project dependencies file. ```sh $ cd docs $ 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: +Or you can install like this. ```sh python3 -m pip install mkdocs ``` + +If you get prompted for `sudo` use, then cancel and run again with `-U` flag for user-level install. +