Update README.md
This commit is contained in:
parent
22fd988f21
commit
0d9e530df8
1 changed files with 14 additions and 2 deletions
16
README.md
16
README.md
|
@ -23,6 +23,18 @@ I would recommended creating an alias for using it. For example:
|
||||||
alias mkdocs="python ~/.local/lib/python3.11/site-packages/mkdocs/__main__.py"
|
alias mkdocs="python ~/.local/lib/python3.11/site-packages/mkdocs/__main__.py"
|
||||||
```
|
```
|
||||||
|
|
||||||
## "Compiling"
|
## Building
|
||||||
|
|
||||||
(unfinished)
|
Build the website through:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ mkdocs build
|
||||||
|
```
|
||||||
|
|
||||||
|
And preview it with:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ mkdocs serve
|
||||||
|
```
|
||||||
|
|
||||||
|
This will host the website localy on [http://127.0.0.1:8000/](http://127.0.0.1:8000/).
|
Loading…
Reference in a new issue