mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-08-11 19:32:46 +02:00
docs: Update instructions
This commit is contained in:
@@ -16,8 +16,17 @@
|
|||||||
|
|
||||||
Choose or setup a MkDocs project.
|
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
|
## Install project dependencies
|
||||||
@@ -39,9 +48,10 @@ Activate it.
|
|||||||
$ source venv/bin/activate
|
$ source venv/bin/activate
|
||||||
```
|
```
|
||||||
|
|
||||||
Install `mkdocs` from project dependencies list.
|
Install `mkdocs` from the project dependencies list.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
|
$ cd docs
|
||||||
$ pip install -r requirements.txt
|
$ pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,37 @@
|
|||||||
# Usage
|
# Usage
|
||||||
> Build and preview a site locally
|
> 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
|
## Serve docs
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user