Skip to content

Commit d08e0b6

Browse files
authored
Update mkdocs/mike notes in readme (#264)
Signed-off-by: Dean Roehrich <dean.roehrich@hpe.com>
1 parent 5fbd266 commit d08e0b6

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,25 @@ $ . venv/bin/activate
1818
(venv) $ pip install -r mkdocs_requirements.txt
1919
```
2020

21-
### Run mkdocs Server
21+
### Run mkdocs or mike Server
2222

2323
To run mkdocs server locally, execute `mkdocs serve`. The output will appear similar to below, with the localhost URL listed at the end.
2424

2525
```bash
26-
(venv) $ mkdocs serve
26+
(venv) $ venv/bin/mkdocs serve
2727
INFO - Building documentation...
2828
[...]
2929
INFO - Documentation built in 0.22 seconds
3030
INFO - [10:59:28] Watching paths for changes: 'docs', 'mkdocs.yml'
3131
INFO - [10:59:28] Serving on http://127.0.0.1:8000/
3232
```
33+
34+
Or run `mike serve`.
35+
36+
```bash
37+
(venv) $ venv/bin/mike serve
38+
Starting server at http://localhost:8000/
39+
Press Ctrl+C to quit.
40+
CStopping server...
41+
```
42+

0 commit comments

Comments
 (0)