iarv/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-05-02 03:22:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update docs

Browse Source
This commit is contained in:
Michael Currin
2020-10-17 16:23:20 +02:00
parent b842ce958e
commit 5e8b217c8d
4 changed files with 47 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/tutorial/installation.md
View File

@@ -30,31 +30,21 @@ For more info, see the [Installation](https://www.mkdocs.org/#installation) page
Create a virtual environment at the project root.
```sh
python3 -m venv venv
$ python3 -m venv venv
```
Activate it.
```sh
source venv/bin/activate
$ source venv/bin/activate
```
Install dependencies using one of these approaches:
<!-- Using `sh` for code block breaks for bullet points at least for read the docs theme. It looks like code can't go in bullet point after all. -->
Install directly.
Install `mkdocs` from project dependencies list.
```sh
pip install mkdocs
$ pip install -r requirements.txt
```
Create a `requirements.txt` file, add `mkdocs` to it then install from the file.
```sh
echo 'mkdocs' > requirements.txt
pip install -r requirements.txt
```
### Install globally