docs: Update instructions

This commit is contained in:
Michael Currin
2020-10-17 17:10:04 +02:00
parent 887d08bc3c
commit e577bb912b
2 changed files with 44 additions and 3 deletions

View File

@@ -16,8 +16,17 @@
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.
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.
e.g.
```sh
$ git clone git@github.com:MichaelCurrin/mkdocs-quickstart.git
$ cd mkdocs-quickstart
```
## Install project dependencies
@@ -39,9 +48,10 @@ Activate it.
$ source venv/bin/activate
```
Install `mkdocs` from project dependencies list.
Install `mkdocs` from the project dependencies list.
```sh
$ cd docs
$ pip install -r requirements.txt
```

View File

@@ -1,6 +1,37 @@
# Usage
> Build and preview a site locally
Make sure to run all commands from the `docs` directory.
```sh
$ cd docs
```
## CLI help
```sh
$ make help
```
```
.PHONY: docs
default: install
h help:
install:
s serve:
b build:
d deploy:
```
## Serve docs