adam/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-07-21 09:02:48 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update installation.md

Browse Source
This commit is contained in:
Michael Currin
2020-12-18 12:22:56 +02:00
committed by GitHub
parent e49c7ae2b3
commit 6f2b3c818e
1 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/tutorial/installation.md
+11 -12
View File
@@ -12,18 +12,15 @@
<script src="https://gist.github.com/MichaelCurrin/57caae30bd7b0991098e9804a9494c23.js"></script> <script src="https://gist.github.com/MichaelCurrin/57caae30bd7b0991098e9804a9494c23.js"></script>
## Setup repo ## Setup a new repo
Choose or setup a MkDocs project. Follow the Tutorial page to setup a project from scratch.
Or click this create your own copy of the repo.
Follow the tutorial page to setup a project.
Or click the button on this repo to 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) [![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. e.g.
@@ -40,34 +37,36 @@ For more info, see the [Installation](https://www.mkdocs.org/#installation) page
### Use a virtual environment ### 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 ```sh
$ python3 -m venv venv $ python3 -m venv venv
``` ```
Activate it. Activate the environment.
```sh ```sh
$ source venv/bin/activate $ source venv/bin/activate
``` ```
Install `mkdocs` from the project dependencies list. Install `mkdocs` - this is covered in the project dependencies file.
```sh ```sh
$ cd docs $ cd docs
$ pip install -r requirements.txt $ pip install -r requirements.txt
``` ```
### Install globally ### Install globally
If you prefer to install MkDocs once and reuse it across projects, then you can install it 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`. 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 ```sh
python3 -m pip install mkdocs python3 -m pip install mkdocs
``` ```
If you get prompted for `sudo` use, then cancel and run again with `-U` flag for user-level install.