From e577bb912ba1ca1e9590e358014fe05272a3ccb4 Mon Sep 17 00:00:00 2001 From: Michael Currin <18750745+MichaelCurrin@users.noreply.github.com> Date: Sat, 17 Oct 2020 17:10:04 +0200 Subject: [PATCH] docs: Update instructions --- docs/docs/tutorial/installation.md | 16 ++++++++++++--- docs/docs/tutorial/usage.md | 31 ++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 3 deletions(-) diff --git a/docs/docs/tutorial/installation.md b/docs/docs/tutorial/installation.md index 191d01a..c94ad16 100644 --- a/docs/docs/tutorial/installation.md +++ b/docs/docs/tutorial/installation.md @@ -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 ``` diff --git a/docs/docs/tutorial/usage.md b/docs/docs/tutorial/usage.md index 6f0c7ff..2d83cbe 100644 --- a/docs/docs/tutorial/usage.md +++ b/docs/docs/tutorial/usage.md @@ -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